From 022db4355cebdf0f5e676a651a91ada0de098259 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Thu, 16 Nov 2023 10:26:18 +0000 Subject: [PATCH 01/75] Initial gh-pages commit From 2585f97a80ca534195e925870f3878282a4015fa Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Thu, 16 Nov 2023 10:26:18 +0000 Subject: [PATCH 02/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@61ba35e2f3164480a8c365762a?= =?UTF-8?q?c68bdc03d4d2f3=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .nojekyll | 1 + assets/highlight.css | 78 ++ assets/main.js | 58 + assets/search.js | 1 + assets/style.css | 1367 +++++++++++++++++++++++ classes/BuildImageDataStack.html | 1200 ++++++++++++++++++++ classes/BuildImagePipelineStack.html | 1170 +++++++++++++++++++ classes/BuildImageRepoStack.html | 1179 +++++++++++++++++++ classes/DemoPipelineStack.html | 1266 +++++++++++++++++++++ classes/PipelineNetworkStack.html | 1177 +++++++++++++++++++ classes/SourceRepo.html | 176 +++ enums/ImageKind.html | 100 ++ enums/ProjectKind.html | 120 ++ index.html | 71 ++ interfaces/BuildImageDataProps.html | 270 +++++ interfaces/BuildImagePipelineProps.html | 290 +++++ interfaces/DemoPipelineProps.html | 310 +++++ interfaces/SourceRepoProps.html | 276 +++++ 18 files changed, 9110 insertions(+) create mode 100644 .nojekyll create mode 100644 assets/highlight.css create mode 100644 assets/main.js create mode 100644 assets/search.js create mode 100644 assets/style.css create mode 100644 classes/BuildImageDataStack.html create mode 100644 classes/BuildImagePipelineStack.html create mode 100644 classes/BuildImageRepoStack.html create mode 100644 classes/DemoPipelineStack.html create mode 100644 classes/PipelineNetworkStack.html create mode 100644 classes/SourceRepo.html create mode 100644 enums/ImageKind.html create mode 100644 enums/ProjectKind.html create mode 100644 index.html create mode 100644 interfaces/BuildImageDataProps.html create mode 100644 interfaces/BuildImagePipelineProps.html create mode 100644 interfaces/DemoPipelineProps.html create mode 100644 interfaces/SourceRepoProps.html diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e2ac661 --- /dev/null +++ b/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/assets/highlight.css b/assets/highlight.css new file mode 100644 index 0000000..35e9a6c --- /dev/null +++ b/assets/highlight.css @@ -0,0 +1,78 @@ +:root { + --light-hl-0: #008000; + --dark-hl-0: #6A9955; + --light-hl-1: #A31515; + --dark-hl-1: #CE9178; + --light-hl-2: #0000FF; + --dark-hl-2: #569CD6; + --light-hl-3: #000000; + --dark-hl-3: #D4D4D4; + --light-hl-4: #0070C1; + --dark-hl-4: #4FC1FF; + --light-hl-5: #267F99; + --dark-hl-5: #4EC9B0; + --light-hl-6: #001080; + --dark-hl-6: #9CDCFE; + --light-hl-7: #795E26; + --dark-hl-7: #DCDCAA; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +pre, code { background: var(--code-background); } diff --git a/assets/main.js b/assets/main.js new file mode 100644 index 0000000..4c8fa61 --- /dev/null +++ b/assets/main.js @@ -0,0 +1,58 @@ +"use strict"; +"use strict";(()=>{var Se=Object.create;var re=Object.defineProperty;var we=Object.getOwnPropertyDescriptor;var Te=Object.getOwnPropertyNames;var ke=Object.getPrototypeOf,Qe=Object.prototype.hasOwnProperty;var Pe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Ie=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Te(e))!Qe.call(t,i)&&i!==r&&re(t,i,{get:()=>e[i],enumerable:!(n=we(e,i))||n.enumerable});return t};var Ce=(t,e,r)=>(r=t!=null?Se(ke(t)):{},Ie(e||!t||!t.__esModule?re(r,"default",{value:t,enumerable:!0}):r,t));var ae=Pe((se,oe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var d=t.utils.clone(r)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(n.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(r+=n[u+1]*i[d+1],u+=2,d+=2);return r},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),r=1,n=0;r0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),y;m in s.node.edges?y=s.node.edges[m]:(y=new t.TokenSet,s.node.edges[m]=y),s.str.length==1&&(y.final=!0),i.push({node:y,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var r=e.peekLexeme();if(r!=null)switch(r.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,r){typeof define=="function"&&define.amd?define(r):typeof se=="object"?oe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ne=[];function G(t,e){ne.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){ne.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n,app:this}),n.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),r=e?.parentElement;for(;r&&!r.classList.contains(".tsd-navigation");)r instanceof HTMLDetailsElement&&(r.open=!0),r=r.parentElement;if(e){let n=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=n}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let r=e.parentElement;for(;r&&r.tagName!=="SECTION";)r=r.parentElement;if(r&&r.offsetParent==null){this.alwaysVisibleMember=r,r.classList.add("always-visible");let n=document.createElement("p");n.classList.add("warning"),n.textContent="This member is normally hidden due to your filter settings.",r.prepend(n)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let r;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(r),r=setTimeout(()=>{e.classList.remove("visible"),r=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let r;return()=>{clearTimeout(r),r=setTimeout(()=>t(),e)}};var ce=Ce(ae());function de(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("tsd-search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Oe(t,n,r,s)}function Oe(t,e,r,n){r.addEventListener("input",ie(()=>{Re(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Fe(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function _e(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ce.Index.load(window.searchData.index))}function Re(t,e,r,n){if(_e(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${le(l.parent,i)}.${u}`);let d=document.createElement("li");d.classList.value=l.classes??"";let m=document.createElement("a");m.href=n.base+l.url,m.innerHTML=u,d.append(m),e.appendChild(d)}}function ue(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Fe(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function le(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(K(t.substring(s))),i.join("")}var Me={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Me[e])}var P=class{constructor(e){this.el=e.el,this.app=e.app}};var M="mousedown",fe="mousemove",N="mouseup",J={x:0,y:0},he=!1,ee=!1,De=!1,D=!1,pe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(pe?"is-mobile":"not-mobile");pe&&"ontouchstart"in document.documentElement&&(De=!0,M="touchstart",fe="touchmove",N="touchend");document.addEventListener(M,t=>{ee=!0,D=!1;let e=M=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=M=="touchstart"?t.targetTouches[0]:t,r=J.x-(e.pageX||0),n=J.y-(e.pageY||0);D=Math.sqrt(r*r+n*n)>10}});document.addEventListener(N,()=>{ee=!1});document.addEventListener("click",t=>{he&&(t.preventDefault(),t.stopImmediatePropagation(),he=!1)});var X=class extends P{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(M,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){D||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!D&&this.active&&r.target.closest(".col-sidebar")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),n.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var me=document.head.appendChild(document.createElement("style"));me.dataset.for="filters";var Y=class extends P{constructor(r){super(r);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),me.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`}fromLocalStorage(){let r=Q.getItem(this.key);return r?r==="true":this.el.checked}setLocalStorage(r){Q.setItem(this.key,r.toString()),this.value=r,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let n=Array.from(r.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);r.style.display=n?"none":"block"})}};var Z=class extends P{constructor(r){super(r);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update()),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ve(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}de();G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var ge=document.getElementById("tsd-theme");ge&&ve(ge);var Ae=new U;Object.defineProperty(window,"app",{value:Ae});document.querySelectorAll("summary a").forEach(t=>{t.addEventListener("click",()=>{location.assign(t.href)})});})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/assets/search.js b/assets/search.js new file mode 100644 index 0000000..14ad00d --- /dev/null +++ b/assets/search.js @@ -0,0 +1 @@ +window.searchData = JSON.parse("{\"rows\":[{\"kind\":128,\"name\":\"PipelineNetworkStack\",\"url\":\"classes/PipelineNetworkStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/PipelineNetworkStack.html#constructor\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"classes/PipelineNetworkStack.html#vpc\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":256,\"name\":\"BuildImageDataProps\",\"url\":\"interfaces/BuildImageDataProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"bucketName\",\"url\":\"interfaces/BuildImageDataProps.html#bucketName\",\"classes\":\"\",\"parent\":\"BuildImageDataProps\"},{\"kind\":128,\"name\":\"BuildImageDataStack\",\"url\":\"classes/BuildImageDataStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageDataStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":1024,\"name\":\"bucket\",\"url\":\"classes/BuildImageDataStack.html#bucket\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":2048,\"name\":\"createDeploymentBucket\",\"url\":\"classes/BuildImageDataStack.html#createDeploymentBucket\",\"classes\":\"tsd-is-private\",\"parent\":\"BuildImageDataStack\"},{\"kind\":128,\"name\":\"BuildImageRepoStack\",\"url\":\"classes/BuildImageRepoStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageRepoStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"classes/BuildImageRepoStack.html#repository\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":8,\"name\":\"ImageKind\",\"url\":\"enums/ImageKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Ubuntu22_04\",\"url\":\"enums/ImageKind.html#Ubuntu22_04\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":16,\"name\":\"Fedora37\",\"url\":\"enums/ImageKind.html#Fedora37\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":16,\"name\":\"Debian11\",\"url\":\"enums/ImageKind.html#Debian11\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":256,\"name\":\"BuildImagePipelineProps\",\"url\":\"interfaces/BuildImagePipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageKind\",\"url\":\"interfaces/BuildImagePipelineProps.html#imageKind\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"dataBucket\",\"url\":\"interfaces/BuildImagePipelineProps.html#dataBucket\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"interfaces/BuildImagePipelineProps.html#repository\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":128,\"name\":\"BuildImagePipelineStack\",\"url\":\"classes/BuildImagePipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImagePipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImagePipelineStack\"},{\"kind\":256,\"name\":\"DemoPipelineProps\",\"url\":\"interfaces/DemoPipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageRepo\",\"url\":\"interfaces/DemoPipelineProps.html#imageRepo\",\"classes\":\"\",\"parent\":\"DemoPipelineProps\"},{\"kind\":1024,\"name\":\"imageTag\",\"url\":\"interfaces/DemoPipelineProps.html#imageTag\",\"classes\":\"\",\"parent\":\"DemoPipelineProps\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"interfaces/DemoPipelineProps.html#vpc\",\"classes\":\"\",\"parent\":\"DemoPipelineProps\"},{\"kind\":1024,\"name\":\"projectKind\",\"url\":\"interfaces/DemoPipelineProps.html#projectKind\",\"classes\":\"\",\"parent\":\"DemoPipelineProps\"},{\"kind\":1024,\"name\":\"layerRepoName\",\"url\":\"interfaces/DemoPipelineProps.html#layerRepoName\",\"classes\":\"\",\"parent\":\"DemoPipelineProps\"},{\"kind\":128,\"name\":\"DemoPipelineStack\",\"url\":\"classes/DemoPipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/DemoPipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addFileSystem\",\"url\":\"classes/DemoPipelineStack.html#addFileSystem\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addVMExportPolicy\",\"url\":\"classes/DemoPipelineStack.html#addVMExportPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIS3BackupPolicy\",\"url\":\"classes/DemoPipelineStack.html#addAMIS3BackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEBSBackupPolicy\",\"url\":\"classes/DemoPipelineStack.html#addAMIEBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIBackupPolicy\",\"url\":\"classes/DemoPipelineStack.html#addAMIBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEC2EBSBackupPolicy\",\"url\":\"classes/DemoPipelineStack.html#addAMIEC2EBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":8,\"name\":\"ProjectKind\",\"url\":\"enums/ProjectKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Poky\",\"url\":\"enums/ProjectKind.html#Poky\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"MetaAwsDemo\",\"url\":\"enums/ProjectKind.html#MetaAwsDemo\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"PokyAmi\",\"url\":\"enums/ProjectKind.html#PokyAmi\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Kas\",\"url\":\"enums/ProjectKind.html#Kas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Renesas\",\"url\":\"enums/ProjectKind.html#Renesas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":256,\"name\":\"SourceRepoProps\",\"url\":\"interfaces/SourceRepoProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"repoName\",\"url\":\"interfaces/SourceRepoProps.html#repoName\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":1024,\"name\":\"kind\",\"url\":\"interfaces/SourceRepoProps.html#kind\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":128,\"name\":\"SourceRepo\",\"url\":\"classes/SourceRepo.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/SourceRepo.html#constructor\",\"classes\":\"\",\"parent\":\"SourceRepo\"},{\"kind\":1024,\"name\":\"repo\",\"url\":\"classes/SourceRepo.html#repo\",\"classes\":\"\",\"parent\":\"SourceRepo\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,34.864]],[\"comment/0\",[]],[\"name/1\",[1,20.2]],[\"comment/1\",[]],[\"name/2\",[2,29.755]],[\"comment/2\",[]],[\"name/3\",[3,34.864]],[\"comment/3\",[]],[\"name/4\",[4,34.864]],[\"comment/4\",[]],[\"name/5\",[5,34.864]],[\"comment/5\",[]],[\"name/6\",[1,20.2]],[\"comment/6\",[]],[\"name/7\",[6,34.864]],[\"comment/7\",[]],[\"name/8\",[7,34.864]],[\"comment/8\",[]],[\"name/9\",[8,34.864]],[\"comment/9\",[]],[\"name/10\",[1,20.2]],[\"comment/10\",[]],[\"name/11\",[9,29.755]],[\"comment/11\",[]],[\"name/12\",[10,29.755]],[\"comment/12\",[]],[\"name/13\",[11,34.864]],[\"comment/13\",[]],[\"name/14\",[12,34.864]],[\"comment/14\",[]],[\"name/15\",[13,34.864]],[\"comment/15\",[]],[\"name/16\",[14,34.864]],[\"comment/16\",[]],[\"name/17\",[10,29.755]],[\"comment/17\",[]],[\"name/18\",[15,34.864]],[\"comment/18\",[]],[\"name/19\",[9,29.755]],[\"comment/19\",[]],[\"name/20\",[16,34.864]],[\"comment/20\",[]],[\"name/21\",[1,20.2]],[\"comment/21\",[]],[\"name/22\",[17,34.864]],[\"comment/22\",[]],[\"name/23\",[18,34.864]],[\"comment/23\",[]],[\"name/24\",[19,34.864]],[\"comment/24\",[]],[\"name/25\",[2,29.755]],[\"comment/25\",[]],[\"name/26\",[20,29.755]],[\"comment/26\",[]],[\"name/27\",[21,34.864]],[\"comment/27\",[]],[\"name/28\",[22,34.864]],[\"comment/28\",[]],[\"name/29\",[1,20.2]],[\"comment/29\",[]],[\"name/30\",[23,34.864]],[\"comment/30\",[]],[\"name/31\",[24,34.864]],[\"comment/31\",[]],[\"name/32\",[25,34.864]],[\"comment/32\",[]],[\"name/33\",[26,34.864]],[\"comment/33\",[]],[\"name/34\",[27,34.864]],[\"comment/34\",[]],[\"name/35\",[28,34.864]],[\"comment/35\",[]],[\"name/36\",[20,29.755]],[\"comment/36\",[]],[\"name/37\",[29,34.864]],[\"comment/37\",[]],[\"name/38\",[30,34.864]],[\"comment/38\",[]],[\"name/39\",[31,34.864]],[\"comment/39\",[]],[\"name/40\",[32,34.864]],[\"comment/40\",[]],[\"name/41\",[33,34.864]],[\"comment/41\",[]],[\"name/42\",[34,34.864]],[\"comment/42\",[]],[\"name/43\",[35,34.864]],[\"comment/43\",[]],[\"name/44\",[36,34.864]],[\"comment/44\",[]],[\"name/45\",[37,34.864]],[\"comment/45\",[]],[\"name/46\",[1,20.2]],[\"comment/46\",[]],[\"name/47\",[38,34.864]],[\"comment/47\",[]]],\"invertedIndex\":[[\"addamibackuppolicy\",{\"_index\":27,\"name\":{\"34\":{}},\"comment\":{}}],[\"addamiebsbackuppolicy\",{\"_index\":26,\"name\":{\"33\":{}},\"comment\":{}}],[\"addamiec2ebsbackuppolicy\",{\"_index\":28,\"name\":{\"35\":{}},\"comment\":{}}],[\"addamis3backuppolicy\",{\"_index\":25,\"name\":{\"32\":{}},\"comment\":{}}],[\"addfilesystem\",{\"_index\":23,\"name\":{\"30\":{}},\"comment\":{}}],[\"addvmexportpolicy\",{\"_index\":24,\"name\":{\"31\":{}},\"comment\":{}}],[\"bucket\",{\"_index\":6,\"name\":{\"7\":{}},\"comment\":{}}],[\"bucketname\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"buildimagedataprops\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"buildimagedatastack\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"buildimagepipelineprops\",{\"_index\":14,\"name\":{\"16\":{}},\"comment\":{}}],[\"buildimagepipelinestack\",{\"_index\":16,\"name\":{\"20\":{}},\"comment\":{}}],[\"buildimagerepostack\",{\"_index\":8,\"name\":{\"9\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{},\"6\":{},\"10\":{},\"21\":{},\"29\":{},\"46\":{}},\"comment\":{}}],[\"createdeploymentbucket\",{\"_index\":7,\"name\":{\"8\":{}},\"comment\":{}}],[\"databucket\",{\"_index\":15,\"name\":{\"18\":{}},\"comment\":{}}],[\"debian11\",{\"_index\":13,\"name\":{\"15\":{}},\"comment\":{}}],[\"demopipelineprops\",{\"_index\":17,\"name\":{\"22\":{}},\"comment\":{}}],[\"demopipelinestack\",{\"_index\":22,\"name\":{\"28\":{}},\"comment\":{}}],[\"fedora37\",{\"_index\":12,\"name\":{\"14\":{}},\"comment\":{}}],[\"imagekind\",{\"_index\":10,\"name\":{\"12\":{},\"17\":{}},\"comment\":{}}],[\"imagerepo\",{\"_index\":18,\"name\":{\"23\":{}},\"comment\":{}}],[\"imagetag\",{\"_index\":19,\"name\":{\"24\":{}},\"comment\":{}}],[\"kas\",{\"_index\":32,\"name\":{\"40\":{}},\"comment\":{}}],[\"kind\",{\"_index\":36,\"name\":{\"44\":{}},\"comment\":{}}],[\"layerreponame\",{\"_index\":21,\"name\":{\"27\":{}},\"comment\":{}}],[\"metaawsdemo\",{\"_index\":30,\"name\":{\"38\":{}},\"comment\":{}}],[\"pipelinenetworkstack\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"poky\",{\"_index\":29,\"name\":{\"37\":{}},\"comment\":{}}],[\"pokyami\",{\"_index\":31,\"name\":{\"39\":{}},\"comment\":{}}],[\"projectkind\",{\"_index\":20,\"name\":{\"26\":{},\"36\":{}},\"comment\":{}}],[\"renesas\",{\"_index\":33,\"name\":{\"41\":{}},\"comment\":{}}],[\"repo\",{\"_index\":38,\"name\":{\"47\":{}},\"comment\":{}}],[\"reponame\",{\"_index\":35,\"name\":{\"43\":{}},\"comment\":{}}],[\"repository\",{\"_index\":9,\"name\":{\"11\":{},\"19\":{}},\"comment\":{}}],[\"sourcerepo\",{\"_index\":37,\"name\":{\"45\":{}},\"comment\":{}}],[\"sourcerepoprops\",{\"_index\":34,\"name\":{\"42\":{}},\"comment\":{}}],[\"ubuntu22_04\",{\"_index\":11,\"name\":{\"13\":{}},\"comment\":{}}],[\"vpc\",{\"_index\":2,\"name\":{\"2\":{},\"25\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/assets/style.css b/assets/style.css new file mode 100644 index 0000000..18b4f8f --- /dev/null +++ b/assets/style.css @@ -0,0 +1,1367 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: var(--light-color-ts-type-alias); + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + /* object literal not included as it is not used and will be removed in 0.25 */ + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: var(--dark-color-ts-type-alias); + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + /* object literal not included as it is not used and will be removed in 0.25 */ + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 > a, +h2 > a, +h3 > a, +h4 > a, +h5 > a, +h6 > a { + text-decoration: none; + color: var(--color-text); +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +.tsd-generator { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} + +.tsd-generator > p { + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography h4, +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; + margin: 0; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.5rem); +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: inline-flex; + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-nested-navigation > li > a, +.tsd-nested-navigation > li > span { + width: calc(100% - 1.75rem - 0.5rem); +} + +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + + cursor: pointer; +} +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + padding: 0 10px; + background-color: var(--color-background); +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current, +#tsd-search .results li:hover { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: block; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-literal { + color: var(--color-ts-type-literal); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html new file mode 100644 index 0000000..caa8b1a --- /dev/null +++ b/classes/BuildImageDataStack.html @@ -0,0 +1,1200 @@ +BuildImageDataStack | aws4embeddedlinux-cdk-lib
+
+ +
+
+
+
+ +

Class BuildImageDataStack

+
+

Input (Source) data for our Build Image Pipeline.

+
+
+
+

Hierarchy

+
    +
  • Stack +
      +
    • BuildImageDataStack
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_crossRegionReferences +_versionReportingEnabled +account +artifactId +bucket +environment +nestedStackResource? +node +region +synthesizer +tags +templateFile +templateOptions +terminationProtection? +
+
+

Accessors

+
availabilityZones +bundlingRequired +dependencies +maxResources +nested +nestedStackParent +notificationArns +partition +permissionsBoundaryArn +stackId +stackName +urlSuffix +
+
+

Methods

+
_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate +_toCloudFormation +_validateId +addDependency +addMetadata +addTransform +allocateLogicalId +createDeploymentBucket +exportStringListValue +exportValue +formatArn +getLogicalId +regionalFact +renameLogicalId +reportMissingContextKey +resolve +splitArn +toJsonString +toString +toYamlString +isConstruct +isStack +of +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly Internal _crossRegionReferences

+
_crossRegionReferences: boolean
+

Whether cross region references are enabled for this stack

+
+
+
+

Readonly Internal _versionReportingEnabled

+
_versionReportingEnabled: boolean
+

Whether version reporting is enabled for this stack

+

Controls whether the CDK Metadata resource is injected

+
+
+
+

Readonly account

+
account: string
+

The AWS account into which this stack will be deployed.

+

This value is resolved according to the following rules:

+
    +
  1. The value provided to env.account when the stack is defined. This can +either be a concrete account (e.g. 585695031111) or the +Aws.ACCOUNT_ID token.
    2. +
  2. Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference +{ "Ref": "AWS::AccountId" } encoded as a string token.
    3. +
+

Preferably, you should use the return value as an opaque string and not +attempt to parse it to implement your logic. If you do, you must first +check that it is a concrete value an not an unresolved token. If this +value is an unresolved token (Token.isUnresolved(stack.account) returns +true), this implies that the user wishes that this stack will synthesize +into a account-agnostic template. In this case, your code should either +fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or +implement some other region-agnostic behavior.

+
+
+
+

Readonly artifactId

+
artifactId: string
+

The ID of the cloud assembly artifact for this stack.

+
+
+
+

Readonly bucket

+
bucket: IBucket
+

The bucket where source for Build Images are.

+
+
+
+

Readonly environment

+
environment: string
+

The environment coordinates in which this stack is deployed. In the form +aws://account/region. Use stack.account and stack.region to obtain +the specific values, no need to parse.

+

You can use this value to determine if two stacks are targeting the same +environment.

+

If either stack.account or stack.region are not concrete values (e.g. +Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or +unknown-region will be used respectively to indicate this stack is +region/account-agnostic.

+
+
+
+

Optional Readonly nestedStackResource

+
nestedStackResource?: CfnResource
+

If this is a nested stack, this represents its AWS::CloudFormation::Stack +resource. undefined for top-level (non-nested) stacks.

+
+
+
+

Readonly node

+
node: Node
+

The tree node.

+
+
+
+

Readonly region

+
region: string
+

The AWS region into which this stack will be deployed (e.g. us-west-2).

+

This value is resolved according to the following rules:

+
    +
  1. The value provided to env.region when the stack is defined. This can +either be a concrete region (e.g. us-west-2) or the Aws.REGION +token.
    2. +
  2. Aws.REGION, which is represents the CloudFormation intrinsic reference +{ "Ref": "AWS::Region" } encoded as a string token.
    3. +
+

Preferably, you should use the return value as an opaque string and not +attempt to parse it to implement your logic. If you do, you must first +check that it is a concrete value an not an unresolved token. If this +value is an unresolved token (Token.isUnresolved(stack.region) returns +true), this implies that the user wishes that this stack will synthesize +into a region-agnostic template. In this case, your code should either +fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or +implement some other region-agnostic behavior.

+
+
+
+

Readonly synthesizer

+
synthesizer: IStackSynthesizer
+

Synthesis method for this stack

+
+
+
+

Readonly tags

+
tags: TagManager
+

Tags to be applied to the stack.

+
+
+
+

Readonly templateFile

+
templateFile: string
+

The name of the CloudFormation template file emitted to the output +directory during synthesis.

+

Example value: MyStack.template.json

+
+
+
+

Readonly templateOptions

+
templateOptions: ITemplateOptions
+

Options for CloudFormation template (like version, transform, description).

+
+
+
+

Optional Readonly terminationProtection

+
terminationProtection?: boolean
+

Whether termination protection is enabled for this stack.

+
+
+
+

Accessors

+
+

availabilityZones

+
    +
  • get availabilityZones(): string[]
    • +
  • +

    Returns the list of AZs that are available in the AWS environment +(account/region) associated with this stack.

    +

    If the stack is environment-agnostic (either account and/or region are +tokens), this property will return an array with 2 tokens that will resolve +at deploy-time to the first two availability zones returned from CloudFormation's +Fn::GetAZs intrinsic function.

    +

    If they are not available in the context, returns a set of dummy values and +reports them as missing, and let the CLI resolve them by calling EC2 +DescribeAvailabilityZones on the target environment.

    +

    To specify a different strategy for selecting availability zones override this method.

    +
    +

    Returns string[]

    +
+
+

bundlingRequired

+
    +
  • get bundlingRequired(): boolean
    • +
  • +

    Indicates whether the stack requires bundling or not

    +
    +

    Returns boolean

    +
+
+

dependencies

+
    +
  • get dependencies(): Stack[]
    • +
  • +

    Return the stacks this stack depends on

    +
    +

    Returns Stack[]

    +
+
+

Private maxResources

+
    +
  • get maxResources(): any
    • +
  • +

    Maximum number of resources in the stack

    +

    Set to 0 to mean "unlimited".

    +
    +

    Returns any

    +
+
+

nested

+
    +
  • get nested(): boolean
    • +
  • +

    Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

    +
    +

    Returns boolean

    +
+
+

nestedStackParent

+
    +
  • get nestedStackParent(): undefined | Stack
    • +
  • +

    If this is a nested stack, returns it's parent stack.

    +
    +

    Returns undefined | Stack

    +
+
+

notificationArns

+
    +
  • get notificationArns(): string[]
    • +
  • +

    Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

    +
    +

    Returns string[]

    +
+
+

partition

+
    +
  • get partition(): string
    • +
  • +

    The partition in which this stack is defined

    +
    +

    Returns string

    +
+
+

Private permissionsBoundaryArn

+
    +
  • get permissionsBoundaryArn(): any
    • +
  • +

    If a permissions boundary has been applied on this scope or any parent scope +then this will return the ARN of the permissions boundary.

    +

    This will return the permissions boundary that has been applied to the most +specific scope.

    +

    For example:

    +

    const stage = new Stage(app, 'stage', { + permissionsBoundary: PermissionsBoundary.fromName('stage-pb'), +});

    +

    const stack = new Stack(stage, 'Stack', { + permissionsBoundary: PermissionsBoundary.fromName('some-other-pb'), +});

    +

    Stack.permissionsBoundaryArn === 'arn:${AWS::Partition}:iam::${AWS::AccountId}:policy/some-other-pb';

    +
    +

    Returns any

    the name of the permissions boundary or undefined if not set

    + +
+
+

stackId

+
    +
  • get stackId(): string
    • +
  • +

    The ID of the stack

    +
    +

    Returns string

    +
    +

    Example

    // After resolving, looks like
    'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+
    +
+
+

stackName

+
    +
  • get stackName(): string
    • +
  • +

    The concrete CloudFormation physical stack name.

    +

    This is either the name defined explicitly in the stackName prop or +allocated based on the stack's location in the construct tree. Stacks that +are directly defined under the app use their construct id as their stack +name. Stacks that are defined deeper within the tree will use a hashed naming +scheme based on the construct path to ensure uniqueness.

    +

    If you wish to obtain the deploy-time AWS::StackName intrinsic, +you can use Aws.STACK_NAME directly.

    +
    +

    Returns string

    +
+
+

urlSuffix

+
    +
  • get urlSuffix(): string
    • +
  • +

    The Amazon domain suffix for the region in which this stack is defined

    +
    +

    Returns string

    +
+
+

Methods

+
+

_addAssemblyDependency

+
    +
  • _addAssemblyDependency(target, reason?): void
    • +
  • Internal +

    Called implicitly by the addDependency helper function in order to +realize a dependency between two top-level stacks at the assembly level.

    +

    Use stack.addDependency to define the dependency between any two stacks, +and take into account nested stack relationships.

    +
    +
    +

    Parameters

    +
      +
    • +
      target: Stack
      • +
    • +
      Optional reason: StackDependencyReason
    +

    Returns void

    +
+
+

_obtainAssemblyDependencies

+
    +
  • _obtainAssemblyDependencies(reasonFilter): Element[]
    • +
  • Internal +

    Called implicitly by the obtainDependencies helper function in order to +collect resource dependencies across two top-level stacks at the assembly level.

    +

    Use stack.obtainDependencies to see the dependencies between any two stacks.

    +
    +
    +

    Parameters

    +
      +
    • +
      reasonFilter: StackDependencyReason
    +

    Returns Element[]

    +
+
+

_removeAssemblyDependency

+
    +
  • _removeAssemblyDependency(target, reasonFilter?): void
    • +
  • Internal +

    Called implicitly by the removeDependency helper function in order to +remove a dependency between two top-level stacks at the assembly level.

    +

    Use stack.addDependency to define the dependency between any two stacks, +and take into account nested stack relationships.

    +
    +
    +

    Parameters

    +
      +
    • +
      target: Stack
      • +
    • +
      Optional reasonFilter: StackDependencyReason
    +

    Returns void

    +
+
+

_synthesizeTemplate

+
    +
  • _synthesizeTemplate(session, lookupRoleArn?): void
    • +
  • Internal +

    Synthesizes the cloudformation template into a cloud assembly.

    +
    +
    +

    Parameters

    +
      +
    • +
      session: ISynthesisSession
      • +
    • +
      Optional lookupRoleArn: string
    +

    Returns void

    +
+
+

Protected _toCloudFormation

+
    +
  • _toCloudFormation(): any
    • +
  • Internal +

    Returns the CloudFormation template for this stack by traversing +the tree and invoking _toCloudFormation() on all Entity objects.

    +
    +

    Returns any

    +
+
+

Protected _validateId

+
    +
  • _validateId(name): void
    • +
  • Internal +

    Validate stack name

    +

    CloudFormation stack names can include dashes in addition to the regular identifier +character classes, and we don't allow one of the magic markers.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
    +

    Returns void

    +
+
+

addDependency

+
    + +
  • +

    Add a dependency between this stack and another stack.

    +

    This can be used to define dependencies between any two stacks within an +app, and also supports nested stacks.

    +
    +
    +

    Parameters

    +
      +
    • +
      target: Stack
      • +
    • +
      Optional reason: string
    +

    Returns void

    +
+
+

addMetadata

+
+
+

addTransform

+
    + +
  • +

    Add a Transform to this stack. A Transform is a macro that AWS +CloudFormation uses to process your template.

    +

    Duplicate values are removed when stack is synthesized.

    +
    +
    +

    Parameters

    +
      +
    • +
      transform: string
      +

      The transform to add

      +
      +
    +

    Returns void

    +
    +

    See

    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

    + +

    Example

    declare const stack: Stack;

    stack.addTransform('AWS::Serverless-2016-10-31')
+
    +
+
+

Protected allocateLogicalId

+
    + +
  • +

    Returns the naming scheme used to allocate logical IDs. By default, uses +the HashedAddressingScheme but this method can be overridden to customize +this behavior.

    +

    In order to make sure logical IDs are unique and stable, we hash the resource +construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as +a suffix to the path components joined without a separator (CloudFormation +IDs only allow alphanumeric characters).

    +

    The result will be:

    +

    <path.join('')><md5(path.join('/')> + "human" "hash"

    +

    If the "human" part of the ID exceeds 240 characters, we simply trim it so +the total ID doesn't exceed CloudFormation's 255 character limit.

    +

    We only take 8 characters from the md5 hash (0.000005 chance of collision).

    +

    Special cases:

    +
      +
    • If the path only contains a single component (i.e. it's a top-level +resource), we won't add the hash to it. The hash is not needed for +disambiguation and also, it allows for a more straightforward migration an +existing CloudFormation template to a CDK stack without logical ID changes +(or renames).
      • +
    • For aesthetic reasons, if the last components of the path are the same +(i.e. L1/L2/Pipeline/Pipeline), they will be de-duplicated to make the +resulting human portion of the ID more pleasing: L1L2Pipeline<HASH> +instead of L1L2PipelinePipeline<HASH>
      • +
    • If a component is named "Default" it will be omitted from the path. This +allows refactoring higher level abstractions around constructs without affecting +the IDs of already deployed resources.
      • +
    • If a component is named "Resource" it will be omitted from the user-visible +path, but included in the hash. This reduces visual noise in the human readable +part of the identifier.
      • +
    +
    +
    +

    Parameters

    +
      +
    • +
      cfnElement: CfnElement
      +

      The element for which the logical ID is allocated.

      +
      +
    +

    Returns string

    +
+
+

Private createDeploymentBucket

+
    + +
  • +

    Create a bucket and S3 deployment to this bucket.

    +
    +
    +

    Parameters

    +
      +
    • +
      bucketName: string
      +

      The name of the bucket. Must be globally unique.

      +
      +
    +

    Returns IBucket

    +
+
+

exportStringListValue

+
    + +
  • +

    Create a CloudFormation Export for a string list value

    +

    Returns a string list representing the corresponding Fn.importValue() +expression for this Export. The export expression is automatically wrapped with an +Fn::Join and the import value with an Fn::Split, since CloudFormation can only +export strings. You can control the name for the export by passing the name option.

    +

    If you don't supply a value for name, the value you're exporting must be +a Resource attribute (for example: bucket.bucketName) and it will be +given the same name as the automatic cross-stack reference that would be created +if you used the attribute in another Stack.

    +

    One of the uses for this method is to remove the relationship between +two Stacks established by automatic cross-stack references. It will +temporarily ensure that the CloudFormation Export still exists while you +remove the reference from the consuming stack. After that, you can remove +the resource and the manual export.

    +

    See exportValue for an example of this process.

    +
    +
    +

    Parameters

    +
      +
    • +
      exportedValue: any
      • +
    • +
      Optional options: ExportValueOptions
    +

    Returns string[]

    +
+
+

exportValue

+
    + +
  • +

    Create a CloudFormation Export for a string value

    +

    Returns a string representing the corresponding Fn.importValue() +expression for this Export. You can control the name for the export by +passing the name option.

    +

    If you don't supply a value for name, the value you're exporting must be +a Resource attribute (for example: bucket.bucketName) and it will be +given the same name as the automatic cross-stack reference that would be created +if you used the attribute in another Stack.

    +

    One of the uses for this method is to remove the relationship between +two Stacks established by automatic cross-stack references. It will +temporarily ensure that the CloudFormation Export still exists while you +remove the reference from the consuming stack. After that, you can remove +the resource and the manual export.

    +

    Example

    Here is how the process works. Let's say there are two stacks, +producerStack and consumerStack, and producerStack has a bucket +called bucket, which is referenced by consumerStack (perhaps because +an AWS Lambda Function writes into it, or something like that).

    +

    It is not safe to remove producerStack.bucket because as the bucket is being +deleted, consumerStack might still be using it.

    +

    Instead, the process takes two deployments:

    +

    Deployment 1: break the relationship

      +
    • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer +stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just +remove the Lambda Function altogether).
      • +
    • In the ProducerStack class, call this.exportValue(this.bucket.bucketName). This +will make sure the CloudFormation Export continues to exist while the relationship +between the two stacks is being broken.
      • +
    • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).
      • +
    +

    Deployment 2: remove the bucket resource

      +
    • You are now free to remove the bucket resource from producerStack.
      • +
    • Don't forget to remove the exportValue() call as well.
      • +
    • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
      • +
    +
    +
    +

    Parameters

    +
      +
    • +
      exportedValue: any
      • +
    • +
      Optional options: ExportValueOptions
    +

    Returns string

    +
+
+

formatArn

+
    + +
  • +

    Creates an ARN from components.

    +

    If partition, region or account are not specified, the stack's +partition, region and account will be used.

    +

    If any component is the empty string, an empty string will be inserted +into the generated ARN at the location that component corresponds to.

    +

    The ARN will be formatted as follows:

    +

    arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

    +

    The required ARN pieces that are omitted will be taken from the stack that +the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope +can be 'undefined'.

    +
    +
    +

    Parameters

    +
      +
    • +
      components: ArnComponents
    +

    Returns string

    +
+
+

getLogicalId

+
    + +
  • +

    Allocates a stack-unique CloudFormation-compatible logical identity for a +specific resource.

    +

    This method is called when a CfnElement is created and used to render the +initial logical identity of resources. Logical ID renames are applied at +this stage.

    +

    This method uses the protected method allocateLogicalId to render the +logical ID for an element. To modify the naming scheme, extend the Stack +class and override this method.

    +
    +
    +

    Parameters

    +
      +
    • +
      element: CfnElement
      +

      The CloudFormation element for which a logical identity is +needed.

      +
      +
    +

    Returns string

    +
+
+

regionalFact

+
    + +
  • +

    Look up a fact value for the given fact for the region of this stack

    +

    Will return a definite value only if the region of the current stack is resolved. +If not, a lookup map will be added to the stack and the lookup will be done at +CDK deployment time.

    +

    What regions will be included in the lookup map is controlled by the +@aws-cdk/core:target-partitions context value: it must be set to a list +of partitions, and only regions from the given partitions will be included. +If no such context key is set, all regions will be included.

    +

    This function is intended to be used by construct library authors. Application +builders can rely on the abstractions offered by construct libraries and do +not have to worry about regional facts.

    +

    If defaultValue is not given, it is an error if the fact is unknown for +the given region.

    +
    +
    +

    Parameters

    +
      +
    • +
      factName: string
      • +
    • +
      Optional defaultValue: string
    +

    Returns string

    +
+
+

renameLogicalId

+
    + +
  • +

    Rename a generated logical identities

    +

    To modify the naming scheme strategy, extend the Stack class and +override the allocateLogicalId method.

    +
    +
    +

    Parameters

    +
      +
    • +
      oldId: string
      • +
    • +
      newId: string
    +

    Returns void

    +
+
+

reportMissingContextKey

+
    + +
  • +

    Indicate that a context key was expected

    +

    Contains instructions which will be emitted into the cloud assembly on how +the key should be supplied.

    +
    +
    +

    Parameters

    +
      +
    • +
      report: MissingContext
      +

      The set of parameters needed to obtain the context

      +
      +
    +

    Returns void

    +
+
+

resolve

+
    + +
  • +

    Resolve a tokenized value in the context of the current stack.

    +
    +
    +

    Parameters

    +
      +
    • +
      obj: any
    +

    Returns any

    +
+
+

splitArn

+
    + +
  • +

    Splits the provided ARN into its components. +Works both if 'arn' is a string like 'arn:aws:s3:::bucket', +and a Token representing a dynamic CloudFormation expression +(in which case the returned components will also be dynamic CloudFormation expressions, +encoded as Tokens).

    +
    +
    +

    Parameters

    +
      +
    • +
      arn: string
      +

      the ARN to split into its components

      +
      +
      • +
    • +
      arnFormat: ArnFormat
      +

      the expected format of 'arn' - depends on what format the service 'arn' represents uses

      +
      +
    +

    Returns ArnComponents

    +
+
+

toJsonString

+
    + +
  • +

    Convert an object, potentially containing tokens, to a JSON string

    +
    +
    +

    Parameters

    +
      +
    • +
      obj: any
      • +
    • +
      Optional space: number
    +

    Returns string

    +
+
+

toString

+
    + +
  • +

    Returns a string representation of this construct.

    +
    +

    Returns string

    +
+
+

toYamlString

+
    + +
  • +

    Convert an object, potentially containing tokens, to a YAML string

    +
    +
    +

    Parameters

    +
      +
    • +
      obj: any
    +

    Returns string

    +
+
+

Static isConstruct

+
    + +
  • +

    Checks if x is a construct.

    +

    Use this method instead of instanceof to properly detect Construct +instances, even when the construct library is symlinked.

    +

    Explanation: in JavaScript, multiple copies of the constructs library on +disk are seen as independent, completely different libraries. As a +consequence, the class Construct in each copy of the constructs library +is seen as a different class, and an instance of one class will not test as +instanceof the other class. npm install will not create installations +like this, but users may manually symlink construct libraries together or +use a monorepo tool: in those cases, multiple copies of the constructs +library can be accidentally installed, and instanceof will behave +unpredictably. It is safest to avoid using instanceof, and using +this type-testing method instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: any
      +

      Any object

      +
      +
    +

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

    + +
+
+

Static isStack

+
    + +
  • +

    Return whether the given object is a Stack.

    +

    We do attribute detection since we can't reliably use 'instanceof'.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: any
    +

    Returns x is Stack

    +
+
+

Static of

+
    + +
  • +

    Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

    +
    +
    +

    Parameters

    +
      +
    • +
      construct: IConstruct
      +

      The construct to start the search from.

      +
      +
    +

    Returns Stack

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/classes/BuildImagePipelineStack.html b/classes/BuildImagePipelineStack.html new file mode 100644 index 0000000..8eb5242 --- /dev/null +++ b/classes/BuildImagePipelineStack.html @@ -0,0 +1,1170 @@ +BuildImagePipelineStack | aws4embeddedlinux-cdk-lib
+
+ +
+
+
+
+ +

Class BuildImagePipelineStack

+
+

The pipeline for building the CodeBuild Image used in other pipelines. This +will produce an image for an OS based on verified Yocto hosts.

+
+
+
+

Hierarchy

+
    +
  • Stack +
      +
    • BuildImagePipelineStack
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_crossRegionReferences +_versionReportingEnabled +account +artifactId +environment +nestedStackResource? +node +region +synthesizer +tags +templateFile +templateOptions +terminationProtection? +
+
+

Accessors

+
availabilityZones +bundlingRequired +dependencies +maxResources +nested +nestedStackParent +notificationArns +partition +permissionsBoundaryArn +stackId +stackName +urlSuffix +
+
+

Methods

+
_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate +_toCloudFormation +_validateId +addDependency +addMetadata +addTransform +allocateLogicalId +exportStringListValue +exportValue +formatArn +getLogicalId +regionalFact +renameLogicalId +reportMissingContextKey +resolve +splitArn +toJsonString +toString +toYamlString +isConstruct +isStack +of +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly Internal _crossRegionReferences

+
_crossRegionReferences: boolean
+

Whether cross region references are enabled for this stack

+
+
+
+

Readonly Internal _versionReportingEnabled

+
_versionReportingEnabled: boolean
+

Whether version reporting is enabled for this stack

+

Controls whether the CDK Metadata resource is injected

+
+
+
+

Readonly account

+
account: string
+

The AWS account into which this stack will be deployed.

+

This value is resolved according to the following rules:

+
    +
  1. The value provided to env.account when the stack is defined. This can +either be a concrete account (e.g. 585695031111) or the +Aws.ACCOUNT_ID token.
    2. +
  2. Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference +{ "Ref": "AWS::AccountId" } encoded as a string token.
    3. +
+

Preferably, you should use the return value as an opaque string and not +attempt to parse it to implement your logic. If you do, you must first +check that it is a concrete value an not an unresolved token. If this +value is an unresolved token (Token.isUnresolved(stack.account) returns +true), this implies that the user wishes that this stack will synthesize +into a account-agnostic template. In this case, your code should either +fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or +implement some other region-agnostic behavior.

+
+
+
+

Readonly artifactId

+
artifactId: string
+

The ID of the cloud assembly artifact for this stack.

+
+
+
+

Readonly environment

+
environment: string
+

The environment coordinates in which this stack is deployed. In the form +aws://account/region. Use stack.account and stack.region to obtain +the specific values, no need to parse.

+

You can use this value to determine if two stacks are targeting the same +environment.

+

If either stack.account or stack.region are not concrete values (e.g. +Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or +unknown-region will be used respectively to indicate this stack is +region/account-agnostic.

+
+
+
+

Optional Readonly nestedStackResource

+
nestedStackResource?: CfnResource
+

If this is a nested stack, this represents its AWS::CloudFormation::Stack +resource. undefined for top-level (non-nested) stacks.

+
+
+
+

Readonly node

+
node: Node
+

The tree node.

+
+
+
+

Readonly region

+
region: string
+

The AWS region into which this stack will be deployed (e.g. us-west-2).

+

This value is resolved according to the following rules:

+
    +
  1. The value provided to env.region when the stack is defined. This can +either be a concrete region (e.g. us-west-2) or the Aws.REGION +token.
    2. +
  2. Aws.REGION, which is represents the CloudFormation intrinsic reference +{ "Ref": "AWS::Region" } encoded as a string token.
    3. +
+

Preferably, you should use the return value as an opaque string and not +attempt to parse it to implement your logic. If you do, you must first +check that it is a concrete value an not an unresolved token. If this +value is an unresolved token (Token.isUnresolved(stack.region) returns +true), this implies that the user wishes that this stack will synthesize +into a region-agnostic template. In this case, your code should either +fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or +implement some other region-agnostic behavior.

+
+
+
+

Readonly synthesizer

+
synthesizer: IStackSynthesizer
+

Synthesis method for this stack

+
+
+
+

Readonly tags

+
tags: TagManager
+

Tags to be applied to the stack.

+
+
+
+

Readonly templateFile

+
templateFile: string
+

The name of the CloudFormation template file emitted to the output +directory during synthesis.

+

Example value: MyStack.template.json

+
+
+
+

Readonly templateOptions

+
templateOptions: ITemplateOptions
+

Options for CloudFormation template (like version, transform, description).

+
+
+
+

Optional Readonly terminationProtection

+
terminationProtection?: boolean
+

Whether termination protection is enabled for this stack.

+
+
+
+

Accessors

+
+

availabilityZones

+
    +
  • get availabilityZones(): string[]
    • +
  • +

    Returns the list of AZs that are available in the AWS environment +(account/region) associated with this stack.

    +

    If the stack is environment-agnostic (either account and/or region are +tokens), this property will return an array with 2 tokens that will resolve +at deploy-time to the first two availability zones returned from CloudFormation's +Fn::GetAZs intrinsic function.

    +

    If they are not available in the context, returns a set of dummy values and +reports them as missing, and let the CLI resolve them by calling EC2 +DescribeAvailabilityZones on the target environment.

    +

    To specify a different strategy for selecting availability zones override this method.

    +
    +

    Returns string[]

    +
+
+

bundlingRequired

+
    +
  • get bundlingRequired(): boolean
    • +
  • +

    Indicates whether the stack requires bundling or not

    +
    +

    Returns boolean

    +
+
+

dependencies

+
    +
  • get dependencies(): Stack[]
    • +
  • +

    Return the stacks this stack depends on

    +
    +

    Returns Stack[]

    +
+
+

Private maxResources

+
    +
  • get maxResources(): any
    • +
  • +

    Maximum number of resources in the stack

    +

    Set to 0 to mean "unlimited".

    +
    +

    Returns any

    +
+
+

nested

+
    +
  • get nested(): boolean
    • +
  • +

    Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

    +
    +

    Returns boolean

    +
+
+

nestedStackParent

+
    +
  • get nestedStackParent(): undefined | Stack
    • +
  • +

    If this is a nested stack, returns it's parent stack.

    +
    +

    Returns undefined | Stack

    +
+
+

notificationArns

+
    +
  • get notificationArns(): string[]
    • +
  • +

    Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

    +
    +

    Returns string[]

    +
+
+

partition

+
    +
  • get partition(): string
    • +
  • +

    The partition in which this stack is defined

    +
    +

    Returns string

    +
+
+

Private permissionsBoundaryArn

+
    +
  • get permissionsBoundaryArn(): any
    • +
  • +

    If a permissions boundary has been applied on this scope or any parent scope +then this will return the ARN of the permissions boundary.

    +

    This will return the permissions boundary that has been applied to the most +specific scope.

    +

    For example:

    +

    const stage = new Stage(app, 'stage', { + permissionsBoundary: PermissionsBoundary.fromName('stage-pb'), +});

    +

    const stack = new Stack(stage, 'Stack', { + permissionsBoundary: PermissionsBoundary.fromName('some-other-pb'), +});

    +

    Stack.permissionsBoundaryArn === 'arn:${AWS::Partition}:iam::${AWS::AccountId}:policy/some-other-pb';

    +
    +

    Returns any

    the name of the permissions boundary or undefined if not set

    + +
+
+

stackId

+
    +
  • get stackId(): string
    • +
  • +

    The ID of the stack

    +
    +

    Returns string

    +
    +

    Example

    // After resolving, looks like
    'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+
    +
+
+

stackName

+
    +
  • get stackName(): string
    • +
  • +

    The concrete CloudFormation physical stack name.

    +

    This is either the name defined explicitly in the stackName prop or +allocated based on the stack's location in the construct tree. Stacks that +are directly defined under the app use their construct id as their stack +name. Stacks that are defined deeper within the tree will use a hashed naming +scheme based on the construct path to ensure uniqueness.

    +

    If you wish to obtain the deploy-time AWS::StackName intrinsic, +you can use Aws.STACK_NAME directly.

    +
    +

    Returns string

    +
+
+

urlSuffix

+
    +
  • get urlSuffix(): string
    • +
  • +

    The Amazon domain suffix for the region in which this stack is defined

    +
    +

    Returns string

    +
+
+

Methods

+
+

_addAssemblyDependency

+
    +
  • _addAssemblyDependency(target, reason?): void
    • +
  • Internal +

    Called implicitly by the addDependency helper function in order to +realize a dependency between two top-level stacks at the assembly level.

    +

    Use stack.addDependency to define the dependency between any two stacks, +and take into account nested stack relationships.

    +
    +
    +

    Parameters

    +
      +
    • +
      target: Stack
      • +
    • +
      Optional reason: StackDependencyReason
    +

    Returns void

    +
+
+

_obtainAssemblyDependencies

+
    +
  • _obtainAssemblyDependencies(reasonFilter): Element[]
    • +
  • Internal +

    Called implicitly by the obtainDependencies helper function in order to +collect resource dependencies across two top-level stacks at the assembly level.

    +

    Use stack.obtainDependencies to see the dependencies between any two stacks.

    +
    +
    +

    Parameters

    +
      +
    • +
      reasonFilter: StackDependencyReason
    +

    Returns Element[]

    +
+
+

_removeAssemblyDependency

+
    +
  • _removeAssemblyDependency(target, reasonFilter?): void
    • +
  • Internal +

    Called implicitly by the removeDependency helper function in order to +remove a dependency between two top-level stacks at the assembly level.

    +

    Use stack.addDependency to define the dependency between any two stacks, +and take into account nested stack relationships.

    +
    +
    +

    Parameters

    +
      +
    • +
      target: Stack
      • +
    • +
      Optional reasonFilter: StackDependencyReason
    +

    Returns void

    +
+
+

_synthesizeTemplate

+
    +
  • _synthesizeTemplate(session, lookupRoleArn?): void
    • +
  • Internal +

    Synthesizes the cloudformation template into a cloud assembly.

    +
    +
    +

    Parameters

    +
      +
    • +
      session: ISynthesisSession
      • +
    • +
      Optional lookupRoleArn: string
    +

    Returns void

    +
+
+

Protected _toCloudFormation

+
    +
  • _toCloudFormation(): any
    • +
  • Internal +

    Returns the CloudFormation template for this stack by traversing +the tree and invoking _toCloudFormation() on all Entity objects.

    +
    +

    Returns any

    +
+
+

Protected _validateId

+
    +
  • _validateId(name): void
    • +
  • Internal +

    Validate stack name

    +

    CloudFormation stack names can include dashes in addition to the regular identifier +character classes, and we don't allow one of the magic markers.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
    +

    Returns void

    +
+
+

addDependency

+
    + +
  • +

    Add a dependency between this stack and another stack.

    +

    This can be used to define dependencies between any two stacks within an +app, and also supports nested stacks.

    +
    +
    +

    Parameters

    +
      +
    • +
      target: Stack
      • +
    • +
      Optional reason: string
    +

    Returns void

    +
+
+

addMetadata

+
+
+

addTransform

+
    + +
  • +

    Add a Transform to this stack. A Transform is a macro that AWS +CloudFormation uses to process your template.

    +

    Duplicate values are removed when stack is synthesized.

    +
    +
    +

    Parameters

    +
      +
    • +
      transform: string
      +

      The transform to add

      +
      +
    +

    Returns void

    +
    +

    See

    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

    + +

    Example

    declare const stack: Stack;

    stack.addTransform('AWS::Serverless-2016-10-31')
+
    +
+
+

Protected allocateLogicalId

+
    + +
  • +

    Returns the naming scheme used to allocate logical IDs. By default, uses +the HashedAddressingScheme but this method can be overridden to customize +this behavior.

    +

    In order to make sure logical IDs are unique and stable, we hash the resource +construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as +a suffix to the path components joined without a separator (CloudFormation +IDs only allow alphanumeric characters).

    +

    The result will be:

    +

    <path.join('')><md5(path.join('/')> + "human" "hash"

    +

    If the "human" part of the ID exceeds 240 characters, we simply trim it so +the total ID doesn't exceed CloudFormation's 255 character limit.

    +

    We only take 8 characters from the md5 hash (0.000005 chance of collision).

    +

    Special cases:

    +
      +
    • If the path only contains a single component (i.e. it's a top-level +resource), we won't add the hash to it. The hash is not needed for +disambiguation and also, it allows for a more straightforward migration an +existing CloudFormation template to a CDK stack without logical ID changes +(or renames).
      • +
    • For aesthetic reasons, if the last components of the path are the same +(i.e. L1/L2/Pipeline/Pipeline), they will be de-duplicated to make the +resulting human portion of the ID more pleasing: L1L2Pipeline<HASH> +instead of L1L2PipelinePipeline<HASH>
      • +
    • If a component is named "Default" it will be omitted from the path. This +allows refactoring higher level abstractions around constructs without affecting +the IDs of already deployed resources.
      • +
    • If a component is named "Resource" it will be omitted from the user-visible +path, but included in the hash. This reduces visual noise in the human readable +part of the identifier.
      • +
    +
    +
    +

    Parameters

    +
      +
    • +
      cfnElement: CfnElement
      +

      The element for which the logical ID is allocated.

      +
      +
    +

    Returns string

    +
+
+

exportStringListValue

+
    + +
  • +

    Create a CloudFormation Export for a string list value

    +

    Returns a string list representing the corresponding Fn.importValue() +expression for this Export. The export expression is automatically wrapped with an +Fn::Join and the import value with an Fn::Split, since CloudFormation can only +export strings. You can control the name for the export by passing the name option.

    +

    If you don't supply a value for name, the value you're exporting must be +a Resource attribute (for example: bucket.bucketName) and it will be +given the same name as the automatic cross-stack reference that would be created +if you used the attribute in another Stack.

    +

    One of the uses for this method is to remove the relationship between +two Stacks established by automatic cross-stack references. It will +temporarily ensure that the CloudFormation Export still exists while you +remove the reference from the consuming stack. After that, you can remove +the resource and the manual export.

    +

    See exportValue for an example of this process.

    +
    +
    +

    Parameters

    +
      +
    • +
      exportedValue: any
      • +
    • +
      Optional options: ExportValueOptions
    +

    Returns string[]

    +
+
+

exportValue

+
    + +
  • +

    Create a CloudFormation Export for a string value

    +

    Returns a string representing the corresponding Fn.importValue() +expression for this Export. You can control the name for the export by +passing the name option.

    +

    If you don't supply a value for name, the value you're exporting must be +a Resource attribute (for example: bucket.bucketName) and it will be +given the same name as the automatic cross-stack reference that would be created +if you used the attribute in another Stack.

    +

    One of the uses for this method is to remove the relationship between +two Stacks established by automatic cross-stack references. It will +temporarily ensure that the CloudFormation Export still exists while you +remove the reference from the consuming stack. After that, you can remove +the resource and the manual export.

    +

    Example

    Here is how the process works. Let's say there are two stacks, +producerStack and consumerStack, and producerStack has a bucket +called bucket, which is referenced by consumerStack (perhaps because +an AWS Lambda Function writes into it, or something like that).

    +

    It is not safe to remove producerStack.bucket because as the bucket is being +deleted, consumerStack might still be using it.

    +

    Instead, the process takes two deployments:

    +

    Deployment 1: break the relationship

      +
    • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer +stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just +remove the Lambda Function altogether).
      • +
    • In the ProducerStack class, call this.exportValue(this.bucket.bucketName). This +will make sure the CloudFormation Export continues to exist while the relationship +between the two stacks is being broken.
      • +
    • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).
      • +
    +

    Deployment 2: remove the bucket resource

      +
    • You are now free to remove the bucket resource from producerStack.
      • +
    • Don't forget to remove the exportValue() call as well.
      • +
    • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
      • +
    +
    +
    +

    Parameters

    +
      +
    • +
      exportedValue: any
      • +
    • +
      Optional options: ExportValueOptions
    +

    Returns string

    +
+
+

formatArn

+
    + +
  • +

    Creates an ARN from components.

    +

    If partition, region or account are not specified, the stack's +partition, region and account will be used.

    +

    If any component is the empty string, an empty string will be inserted +into the generated ARN at the location that component corresponds to.

    +

    The ARN will be formatted as follows:

    +

    arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

    +

    The required ARN pieces that are omitted will be taken from the stack that +the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope +can be 'undefined'.

    +
    +
    +

    Parameters

    +
      +
    • +
      components: ArnComponents
    +

    Returns string

    +
+
+

getLogicalId

+
    + +
  • +

    Allocates a stack-unique CloudFormation-compatible logical identity for a +specific resource.

    +

    This method is called when a CfnElement is created and used to render the +initial logical identity of resources. Logical ID renames are applied at +this stage.

    +

    This method uses the protected method allocateLogicalId to render the +logical ID for an element. To modify the naming scheme, extend the Stack +class and override this method.

    +
    +
    +

    Parameters

    +
      +
    • +
      element: CfnElement
      +

      The CloudFormation element for which a logical identity is +needed.

      +
      +
    +

    Returns string

    +
+
+

regionalFact

+
    + +
  • +

    Look up a fact value for the given fact for the region of this stack

    +

    Will return a definite value only if the region of the current stack is resolved. +If not, a lookup map will be added to the stack and the lookup will be done at +CDK deployment time.

    +

    What regions will be included in the lookup map is controlled by the +@aws-cdk/core:target-partitions context value: it must be set to a list +of partitions, and only regions from the given partitions will be included. +If no such context key is set, all regions will be included.

    +

    This function is intended to be used by construct library authors. Application +builders can rely on the abstractions offered by construct libraries and do +not have to worry about regional facts.

    +

    If defaultValue is not given, it is an error if the fact is unknown for +the given region.

    +
    +
    +

    Parameters

    +
      +
    • +
      factName: string
      • +
    • +
      Optional defaultValue: string
    +

    Returns string

    +
+
+

renameLogicalId

+
    + +
  • +

    Rename a generated logical identities

    +

    To modify the naming scheme strategy, extend the Stack class and +override the allocateLogicalId method.

    +
    +
    +

    Parameters

    +
      +
    • +
      oldId: string
      • +
    • +
      newId: string
    +

    Returns void

    +
+
+

reportMissingContextKey

+
    + +
  • +

    Indicate that a context key was expected

    +

    Contains instructions which will be emitted into the cloud assembly on how +the key should be supplied.

    +
    +
    +

    Parameters

    +
      +
    • +
      report: MissingContext
      +

      The set of parameters needed to obtain the context

      +
      +
    +

    Returns void

    +
+
+

resolve

+
    + +
  • +

    Resolve a tokenized value in the context of the current stack.

    +
    +
    +

    Parameters

    +
      +
    • +
      obj: any
    +

    Returns any

    +
+
+

splitArn

+
    + +
  • +

    Splits the provided ARN into its components. +Works both if 'arn' is a string like 'arn:aws:s3:::bucket', +and a Token representing a dynamic CloudFormation expression +(in which case the returned components will also be dynamic CloudFormation expressions, +encoded as Tokens).

    +
    +
    +

    Parameters

    +
      +
    • +
      arn: string
      +

      the ARN to split into its components

      +
      +
      • +
    • +
      arnFormat: ArnFormat
      +

      the expected format of 'arn' - depends on what format the service 'arn' represents uses

      +
      +
    +

    Returns ArnComponents

    +
+
+

toJsonString

+
    + +
  • +

    Convert an object, potentially containing tokens, to a JSON string

    +
    +
    +

    Parameters

    +
      +
    • +
      obj: any
      • +
    • +
      Optional space: number
    +

    Returns string

    +
+
+

toString

+
    + +
  • +

    Returns a string representation of this construct.

    +
    +

    Returns string

    +
+
+

toYamlString

+
    + +
  • +

    Convert an object, potentially containing tokens, to a YAML string

    +
    +
    +

    Parameters

    +
      +
    • +
      obj: any
    +

    Returns string

    +
+
+

Static isConstruct

+
    + +
  • +

    Checks if x is a construct.

    +

    Use this method instead of instanceof to properly detect Construct +instances, even when the construct library is symlinked.

    +

    Explanation: in JavaScript, multiple copies of the constructs library on +disk are seen as independent, completely different libraries. As a +consequence, the class Construct in each copy of the constructs library +is seen as a different class, and an instance of one class will not test as +instanceof the other class. npm install will not create installations +like this, but users may manually symlink construct libraries together or +use a monorepo tool: in those cases, multiple copies of the constructs +library can be accidentally installed, and instanceof will behave +unpredictably. It is safest to avoid using instanceof, and using +this type-testing method instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: any
      +

      Any object

      +
      +
    +

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

    + +
+
+

Static isStack

+
    + +
  • +

    Return whether the given object is a Stack.

    +

    We do attribute detection since we can't reliably use 'instanceof'.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: any
    +

    Returns x is Stack

    +
+
+

Static of

+
    + +
  • +

    Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

    +
    +
    +

    Parameters

    +
      +
    • +
      construct: IConstruct
      +

      The construct to start the search from.

      +
      +
    +

    Returns Stack

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html new file mode 100644 index 0000000..8795bc1 --- /dev/null +++ b/classes/BuildImageRepoStack.html @@ -0,0 +1,1179 @@ +BuildImageRepoStack | aws4embeddedlinux-cdk-lib
+
+ +
+
+
+
+ +

Class BuildImageRepoStack

+
+

The ECR Repository to store build host images.

+
+
+
+

Hierarchy

+
    +
  • Stack +
      +
    • BuildImageRepoStack
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_crossRegionReferences +_versionReportingEnabled +account +artifactId +environment +nestedStackResource? +node +region +repository +synthesizer +tags +templateFile +templateOptions +terminationProtection? +
+
+

Accessors

+
availabilityZones +bundlingRequired +dependencies +maxResources +nested +nestedStackParent +notificationArns +partition +permissionsBoundaryArn +stackId +stackName +urlSuffix +
+
+

Methods

+
_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate +_toCloudFormation +_validateId +addDependency +addMetadata +addTransform +allocateLogicalId +exportStringListValue +exportValue +formatArn +getLogicalId +regionalFact +renameLogicalId +reportMissingContextKey +resolve +splitArn +toJsonString +toString +toYamlString +isConstruct +isStack +of +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly Internal _crossRegionReferences

+
_crossRegionReferences: boolean
+

Whether cross region references are enabled for this stack

+
+
+
+

Readonly Internal _versionReportingEnabled

+
_versionReportingEnabled: boolean
+

Whether version reporting is enabled for this stack

+

Controls whether the CDK Metadata resource is injected

+
+
+
+

Readonly account

+
account: string
+

The AWS account into which this stack will be deployed.

+

This value is resolved according to the following rules:

+
    +
  1. The value provided to env.account when the stack is defined. This can +either be a concrete account (e.g. 585695031111) or the +Aws.ACCOUNT_ID token.
    2. +
  2. Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference +{ "Ref": "AWS::AccountId" } encoded as a string token.
    3. +
+

Preferably, you should use the return value as an opaque string and not +attempt to parse it to implement your logic. If you do, you must first +check that it is a concrete value an not an unresolved token. If this +value is an unresolved token (Token.isUnresolved(stack.account) returns +true), this implies that the user wishes that this stack will synthesize +into a account-agnostic template. In this case, your code should either +fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or +implement some other region-agnostic behavior.

+
+
+
+

Readonly artifactId

+
artifactId: string
+

The ID of the cloud assembly artifact for this stack.

+
+
+
+

Readonly environment

+
environment: string
+

The environment coordinates in which this stack is deployed. In the form +aws://account/region. Use stack.account and stack.region to obtain +the specific values, no need to parse.

+

You can use this value to determine if two stacks are targeting the same +environment.

+

If either stack.account or stack.region are not concrete values (e.g. +Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or +unknown-region will be used respectively to indicate this stack is +region/account-agnostic.

+
+
+
+

Optional Readonly nestedStackResource

+
nestedStackResource?: CfnResource
+

If this is a nested stack, this represents its AWS::CloudFormation::Stack +resource. undefined for top-level (non-nested) stacks.

+
+
+
+

Readonly node

+
node: Node
+

The tree node.

+
+
+
+

Readonly region

+
region: string
+

The AWS region into which this stack will be deployed (e.g. us-west-2).

+

This value is resolved according to the following rules:

+
    +
  1. The value provided to env.region when the stack is defined. This can +either be a concrete region (e.g. us-west-2) or the Aws.REGION +token.
    2. +
  2. Aws.REGION, which is represents the CloudFormation intrinsic reference +{ "Ref": "AWS::Region" } encoded as a string token.
    3. +
+

Preferably, you should use the return value as an opaque string and not +attempt to parse it to implement your logic. If you do, you must first +check that it is a concrete value an not an unresolved token. If this +value is an unresolved token (Token.isUnresolved(stack.region) returns +true), this implies that the user wishes that this stack will synthesize +into a region-agnostic template. In this case, your code should either +fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or +implement some other region-agnostic behavior.

+
+
+
+

Readonly repository

+
repository: IRepository
+

The respository to put the build host container in.

+
+
+
+

Readonly synthesizer

+
synthesizer: IStackSynthesizer
+

Synthesis method for this stack

+
+
+
+

Readonly tags

+
tags: TagManager
+

Tags to be applied to the stack.

+
+
+
+

Readonly templateFile

+
templateFile: string
+

The name of the CloudFormation template file emitted to the output +directory during synthesis.

+

Example value: MyStack.template.json

+
+
+
+

Readonly templateOptions

+
templateOptions: ITemplateOptions
+

Options for CloudFormation template (like version, transform, description).

+
+
+
+

Optional Readonly terminationProtection

+
terminationProtection?: boolean
+

Whether termination protection is enabled for this stack.

+
+
+
+

Accessors

+
+

availabilityZones

+
    +
  • get availabilityZones(): string[]
    • +
  • +

    Returns the list of AZs that are available in the AWS environment +(account/region) associated with this stack.

    +

    If the stack is environment-agnostic (either account and/or region are +tokens), this property will return an array with 2 tokens that will resolve +at deploy-time to the first two availability zones returned from CloudFormation's +Fn::GetAZs intrinsic function.

    +

    If they are not available in the context, returns a set of dummy values and +reports them as missing, and let the CLI resolve them by calling EC2 +DescribeAvailabilityZones on the target environment.

    +

    To specify a different strategy for selecting availability zones override this method.

    +
    +

    Returns string[]

    +
+
+

bundlingRequired

+
    +
  • get bundlingRequired(): boolean
    • +
  • +

    Indicates whether the stack requires bundling or not

    +
    +

    Returns boolean

    +
+
+

dependencies

+
    +
  • get dependencies(): Stack[]
    • +
  • +

    Return the stacks this stack depends on

    +
    +

    Returns Stack[]

    +
+
+

Private maxResources

+
    +
  • get maxResources(): any
    • +
  • +

    Maximum number of resources in the stack

    +

    Set to 0 to mean "unlimited".

    +
    +

    Returns any

    +
+
+

nested

+
    +
  • get nested(): boolean
    • +
  • +

    Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

    +
    +

    Returns boolean

    +
+
+

nestedStackParent

+
    +
  • get nestedStackParent(): undefined | Stack
    • +
  • +

    If this is a nested stack, returns it's parent stack.

    +
    +

    Returns undefined | Stack

    +
+
+

notificationArns

+
    +
  • get notificationArns(): string[]
    • +
  • +

    Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

    +
    +

    Returns string[]

    +
+
+

partition

+
    +
  • get partition(): string
    • +
  • +

    The partition in which this stack is defined

    +
    +

    Returns string

    +
+
+

Private permissionsBoundaryArn

+
    +
  • get permissionsBoundaryArn(): any
    • +
  • +

    If a permissions boundary has been applied on this scope or any parent scope +then this will return the ARN of the permissions boundary.

    +

    This will return the permissions boundary that has been applied to the most +specific scope.

    +

    For example:

    +

    const stage = new Stage(app, 'stage', { + permissionsBoundary: PermissionsBoundary.fromName('stage-pb'), +});

    +

    const stack = new Stack(stage, 'Stack', { + permissionsBoundary: PermissionsBoundary.fromName('some-other-pb'), +});

    +

    Stack.permissionsBoundaryArn === 'arn:${AWS::Partition}:iam::${AWS::AccountId}:policy/some-other-pb';

    +
    +

    Returns any

    the name of the permissions boundary or undefined if not set

    + +
+
+

stackId

+
    +
  • get stackId(): string
    • +
  • +

    The ID of the stack

    +
    +

    Returns string

    +
    +

    Example

    // After resolving, looks like
    'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+
    +
+
+

stackName

+
    +
  • get stackName(): string
    • +
  • +

    The concrete CloudFormation physical stack name.

    +

    This is either the name defined explicitly in the stackName prop or +allocated based on the stack's location in the construct tree. Stacks that +are directly defined under the app use their construct id as their stack +name. Stacks that are defined deeper within the tree will use a hashed naming +scheme based on the construct path to ensure uniqueness.

    +

    If you wish to obtain the deploy-time AWS::StackName intrinsic, +you can use Aws.STACK_NAME directly.

    +
    +

    Returns string

    +
+
+

urlSuffix

+
    +
  • get urlSuffix(): string
    • +
  • +

    The Amazon domain suffix for the region in which this stack is defined

    +
    +

    Returns string

    +
+
+

Methods

+
+

_addAssemblyDependency

+
    +
  • _addAssemblyDependency(target, reason?): void
    • +
  • Internal +

    Called implicitly by the addDependency helper function in order to +realize a dependency between two top-level stacks at the assembly level.

    +

    Use stack.addDependency to define the dependency between any two stacks, +and take into account nested stack relationships.

    +
    +
    +

    Parameters

    +
      +
    • +
      target: Stack
      • +
    • +
      Optional reason: StackDependencyReason
    +

    Returns void

    +
+
+

_obtainAssemblyDependencies

+
    +
  • _obtainAssemblyDependencies(reasonFilter): Element[]
    • +
  • Internal +

    Called implicitly by the obtainDependencies helper function in order to +collect resource dependencies across two top-level stacks at the assembly level.

    +

    Use stack.obtainDependencies to see the dependencies between any two stacks.

    +
    +
    +

    Parameters

    +
      +
    • +
      reasonFilter: StackDependencyReason
    +

    Returns Element[]

    +
+
+

_removeAssemblyDependency

+
    +
  • _removeAssemblyDependency(target, reasonFilter?): void
    • +
  • Internal +

    Called implicitly by the removeDependency helper function in order to +remove a dependency between two top-level stacks at the assembly level.

    +

    Use stack.addDependency to define the dependency between any two stacks, +and take into account nested stack relationships.

    +
    +
    +

    Parameters

    +
      +
    • +
      target: Stack
      • +
    • +
      Optional reasonFilter: StackDependencyReason
    +

    Returns void

    +
+
+

_synthesizeTemplate

+
    +
  • _synthesizeTemplate(session, lookupRoleArn?): void
    • +
  • Internal +

    Synthesizes the cloudformation template into a cloud assembly.

    +
    +
    +

    Parameters

    +
      +
    • +
      session: ISynthesisSession
      • +
    • +
      Optional lookupRoleArn: string
    +

    Returns void

    +
+
+

Protected _toCloudFormation

+
    +
  • _toCloudFormation(): any
    • +
  • Internal +

    Returns the CloudFormation template for this stack by traversing +the tree and invoking _toCloudFormation() on all Entity objects.

    +
    +

    Returns any

    +
+
+

Protected _validateId

+
    +
  • _validateId(name): void
    • +
  • Internal +

    Validate stack name

    +

    CloudFormation stack names can include dashes in addition to the regular identifier +character classes, and we don't allow one of the magic markers.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
    +

    Returns void

    +
+
+

addDependency

+
    + +
  • +

    Add a dependency between this stack and another stack.

    +

    This can be used to define dependencies between any two stacks within an +app, and also supports nested stacks.

    +
    +
    +

    Parameters

    +
      +
    • +
      target: Stack
      • +
    • +
      Optional reason: string
    +

    Returns void

    +
+
+

addMetadata

+
+
+

addTransform

+
    + +
  • +

    Add a Transform to this stack. A Transform is a macro that AWS +CloudFormation uses to process your template.

    +

    Duplicate values are removed when stack is synthesized.

    +
    +
    +

    Parameters

    +
      +
    • +
      transform: string
      +

      The transform to add

      +
      +
    +

    Returns void

    +
    +

    See

    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

    + +

    Example

    declare const stack: Stack;

    stack.addTransform('AWS::Serverless-2016-10-31')
+
    +
+
+

Protected allocateLogicalId

+
    + +
  • +

    Returns the naming scheme used to allocate logical IDs. By default, uses +the HashedAddressingScheme but this method can be overridden to customize +this behavior.

    +

    In order to make sure logical IDs are unique and stable, we hash the resource +construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as +a suffix to the path components joined without a separator (CloudFormation +IDs only allow alphanumeric characters).

    +

    The result will be:

    +

    <path.join('')><md5(path.join('/')> + "human" "hash"

    +

    If the "human" part of the ID exceeds 240 characters, we simply trim it so +the total ID doesn't exceed CloudFormation's 255 character limit.

    +

    We only take 8 characters from the md5 hash (0.000005 chance of collision).

    +

    Special cases:

    +
      +
    • If the path only contains a single component (i.e. it's a top-level +resource), we won't add the hash to it. The hash is not needed for +disambiguation and also, it allows for a more straightforward migration an +existing CloudFormation template to a CDK stack without logical ID changes +(or renames).
      • +
    • For aesthetic reasons, if the last components of the path are the same +(i.e. L1/L2/Pipeline/Pipeline), they will be de-duplicated to make the +resulting human portion of the ID more pleasing: L1L2Pipeline<HASH> +instead of L1L2PipelinePipeline<HASH>
      • +
    • If a component is named "Default" it will be omitted from the path. This +allows refactoring higher level abstractions around constructs without affecting +the IDs of already deployed resources.
      • +
    • If a component is named "Resource" it will be omitted from the user-visible +path, but included in the hash. This reduces visual noise in the human readable +part of the identifier.
      • +
    +
    +
    +

    Parameters

    +
      +
    • +
      cfnElement: CfnElement
      +

      The element for which the logical ID is allocated.

      +
      +
    +

    Returns string

    +
+
+

exportStringListValue

+
    + +
  • +

    Create a CloudFormation Export for a string list value

    +

    Returns a string list representing the corresponding Fn.importValue() +expression for this Export. The export expression is automatically wrapped with an +Fn::Join and the import value with an Fn::Split, since CloudFormation can only +export strings. You can control the name for the export by passing the name option.

    +

    If you don't supply a value for name, the value you're exporting must be +a Resource attribute (for example: bucket.bucketName) and it will be +given the same name as the automatic cross-stack reference that would be created +if you used the attribute in another Stack.

    +

    One of the uses for this method is to remove the relationship between +two Stacks established by automatic cross-stack references. It will +temporarily ensure that the CloudFormation Export still exists while you +remove the reference from the consuming stack. After that, you can remove +the resource and the manual export.

    +

    See exportValue for an example of this process.

    +
    +
    +

    Parameters

    +
      +
    • +
      exportedValue: any
      • +
    • +
      Optional options: ExportValueOptions
    +

    Returns string[]

    +
+
+

exportValue

+
    + +
  • +

    Create a CloudFormation Export for a string value

    +

    Returns a string representing the corresponding Fn.importValue() +expression for this Export. You can control the name for the export by +passing the name option.

    +

    If you don't supply a value for name, the value you're exporting must be +a Resource attribute (for example: bucket.bucketName) and it will be +given the same name as the automatic cross-stack reference that would be created +if you used the attribute in another Stack.

    +

    One of the uses for this method is to remove the relationship between +two Stacks established by automatic cross-stack references. It will +temporarily ensure that the CloudFormation Export still exists while you +remove the reference from the consuming stack. After that, you can remove +the resource and the manual export.

    +

    Example

    Here is how the process works. Let's say there are two stacks, +producerStack and consumerStack, and producerStack has a bucket +called bucket, which is referenced by consumerStack (perhaps because +an AWS Lambda Function writes into it, or something like that).

    +

    It is not safe to remove producerStack.bucket because as the bucket is being +deleted, consumerStack might still be using it.

    +

    Instead, the process takes two deployments:

    +

    Deployment 1: break the relationship

      +
    • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer +stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just +remove the Lambda Function altogether).
      • +
    • In the ProducerStack class, call this.exportValue(this.bucket.bucketName). This +will make sure the CloudFormation Export continues to exist while the relationship +between the two stacks is being broken.
      • +
    • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).
      • +
    +

    Deployment 2: remove the bucket resource

      +
    • You are now free to remove the bucket resource from producerStack.
      • +
    • Don't forget to remove the exportValue() call as well.
      • +
    • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
      • +
    +
    +
    +

    Parameters

    +
      +
    • +
      exportedValue: any
      • +
    • +
      Optional options: ExportValueOptions
    +

    Returns string

    +
+
+

formatArn

+
    + +
  • +

    Creates an ARN from components.

    +

    If partition, region or account are not specified, the stack's +partition, region and account will be used.

    +

    If any component is the empty string, an empty string will be inserted +into the generated ARN at the location that component corresponds to.

    +

    The ARN will be formatted as follows:

    +

    arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

    +

    The required ARN pieces that are omitted will be taken from the stack that +the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope +can be 'undefined'.

    +
    +
    +

    Parameters

    +
      +
    • +
      components: ArnComponents
    +

    Returns string

    +
+
+

getLogicalId

+
    + +
  • +

    Allocates a stack-unique CloudFormation-compatible logical identity for a +specific resource.

    +

    This method is called when a CfnElement is created and used to render the +initial logical identity of resources. Logical ID renames are applied at +this stage.

    +

    This method uses the protected method allocateLogicalId to render the +logical ID for an element. To modify the naming scheme, extend the Stack +class and override this method.

    +
    +
    +

    Parameters

    +
      +
    • +
      element: CfnElement
      +

      The CloudFormation element for which a logical identity is +needed.

      +
      +
    +

    Returns string

    +
+
+

regionalFact

+
    + +
  • +

    Look up a fact value for the given fact for the region of this stack

    +

    Will return a definite value only if the region of the current stack is resolved. +If not, a lookup map will be added to the stack and the lookup will be done at +CDK deployment time.

    +

    What regions will be included in the lookup map is controlled by the +@aws-cdk/core:target-partitions context value: it must be set to a list +of partitions, and only regions from the given partitions will be included. +If no such context key is set, all regions will be included.

    +

    This function is intended to be used by construct library authors. Application +builders can rely on the abstractions offered by construct libraries and do +not have to worry about regional facts.

    +

    If defaultValue is not given, it is an error if the fact is unknown for +the given region.

    +
    +
    +

    Parameters

    +
      +
    • +
      factName: string
      • +
    • +
      Optional defaultValue: string
    +

    Returns string

    +
+
+

renameLogicalId

+
    + +
  • +

    Rename a generated logical identities

    +

    To modify the naming scheme strategy, extend the Stack class and +override the allocateLogicalId method.

    +
    +
    +

    Parameters

    +
      +
    • +
      oldId: string
      • +
    • +
      newId: string
    +

    Returns void

    +
+
+

reportMissingContextKey

+
    + +
  • +

    Indicate that a context key was expected

    +

    Contains instructions which will be emitted into the cloud assembly on how +the key should be supplied.

    +
    +
    +

    Parameters

    +
      +
    • +
      report: MissingContext
      +

      The set of parameters needed to obtain the context

      +
      +
    +

    Returns void

    +
+
+

resolve

+
    + +
  • +

    Resolve a tokenized value in the context of the current stack.

    +
    +
    +

    Parameters

    +
      +
    • +
      obj: any
    +

    Returns any

    +
+
+

splitArn

+
    + +
  • +

    Splits the provided ARN into its components. +Works both if 'arn' is a string like 'arn:aws:s3:::bucket', +and a Token representing a dynamic CloudFormation expression +(in which case the returned components will also be dynamic CloudFormation expressions, +encoded as Tokens).

    +
    +
    +

    Parameters

    +
      +
    • +
      arn: string
      +

      the ARN to split into its components

      +
      +
      • +
    • +
      arnFormat: ArnFormat
      +

      the expected format of 'arn' - depends on what format the service 'arn' represents uses

      +
      +
    +

    Returns ArnComponents

    +
+
+

toJsonString

+
    + +
  • +

    Convert an object, potentially containing tokens, to a JSON string

    +
    +
    +

    Parameters

    +
      +
    • +
      obj: any
      • +
    • +
      Optional space: number
    +

    Returns string

    +
+
+

toString

+
    + +
  • +

    Returns a string representation of this construct.

    +
    +

    Returns string

    +
+
+

toYamlString

+
    + +
  • +

    Convert an object, potentially containing tokens, to a YAML string

    +
    +
    +

    Parameters

    +
      +
    • +
      obj: any
    +

    Returns string

    +
+
+

Static isConstruct

+
    + +
  • +

    Checks if x is a construct.

    +

    Use this method instead of instanceof to properly detect Construct +instances, even when the construct library is symlinked.

    +

    Explanation: in JavaScript, multiple copies of the constructs library on +disk are seen as independent, completely different libraries. As a +consequence, the class Construct in each copy of the constructs library +is seen as a different class, and an instance of one class will not test as +instanceof the other class. npm install will not create installations +like this, but users may manually symlink construct libraries together or +use a monorepo tool: in those cases, multiple copies of the constructs +library can be accidentally installed, and instanceof will behave +unpredictably. It is safest to avoid using instanceof, and using +this type-testing method instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: any
      +

      Any object

      +
      +
    +

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

    + +
+
+

Static isStack

+
    + +
  • +

    Return whether the given object is a Stack.

    +

    We do attribute detection since we can't reliably use 'instanceof'.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: any
    +

    Returns x is Stack

    +
+
+

Static of

+
    + +
  • +

    Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

    +
    +
    +

    Parameters

    +
      +
    • +
      construct: IConstruct
      +

      The construct to start the search from.

      +
      +
    +

    Returns Stack

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/classes/DemoPipelineStack.html b/classes/DemoPipelineStack.html new file mode 100644 index 0000000..de57441 --- /dev/null +++ b/classes/DemoPipelineStack.html @@ -0,0 +1,1266 @@ +DemoPipelineStack | aws4embeddedlinux-cdk-lib
+
+ +
+
+
+
+ +

Class DemoPipelineStack

+
+

The stack demonstrating how to build a pipeline for meta-aws-demos

+
+
+
+

Hierarchy

+
    +
  • Stack +
      +
    • DemoPipelineStack
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_crossRegionReferences +_versionReportingEnabled +account +artifactId +environment +nestedStackResource? +node +region +synthesizer +tags +templateFile +templateOptions +terminationProtection? +
+
+

Accessors

+
availabilityZones +bundlingRequired +dependencies +maxResources +nested +nestedStackParent +notificationArns +partition +permissionsBoundaryArn +stackId +stackName +urlSuffix +
+
+

Methods

+
_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate +_toCloudFormation +_validateId +addAMIBackupPolicy +addAMIEBSBackupPolicy +addAMIEC2EBSBackupPolicy +addAMIS3BackupPolicy +addDependency +addFileSystem +addMetadata +addTransform +addVMExportPolicy +allocateLogicalId +exportStringListValue +exportValue +formatArn +getLogicalId +regionalFact +renameLogicalId +reportMissingContextKey +resolve +splitArn +toJsonString +toString +toYamlString +isConstruct +isStack +of +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly Internal _crossRegionReferences

+
_crossRegionReferences: boolean
+

Whether cross region references are enabled for this stack

+
+
+
+

Readonly Internal _versionReportingEnabled

+
_versionReportingEnabled: boolean
+

Whether version reporting is enabled for this stack

+

Controls whether the CDK Metadata resource is injected

+
+
+
+

Readonly account

+
account: string
+

The AWS account into which this stack will be deployed.

+

This value is resolved according to the following rules:

+
    +
  1. The value provided to env.account when the stack is defined. This can +either be a concrete account (e.g. 585695031111) or the +Aws.ACCOUNT_ID token.
    2. +
  2. Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference +{ "Ref": "AWS::AccountId" } encoded as a string token.
    3. +
+

Preferably, you should use the return value as an opaque string and not +attempt to parse it to implement your logic. If you do, you must first +check that it is a concrete value an not an unresolved token. If this +value is an unresolved token (Token.isUnresolved(stack.account) returns +true), this implies that the user wishes that this stack will synthesize +into a account-agnostic template. In this case, your code should either +fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or +implement some other region-agnostic behavior.

+
+
+
+

Readonly artifactId

+
artifactId: string
+

The ID of the cloud assembly artifact for this stack.

+
+
+
+

Readonly environment

+
environment: string
+

The environment coordinates in which this stack is deployed. In the form +aws://account/region. Use stack.account and stack.region to obtain +the specific values, no need to parse.

+

You can use this value to determine if two stacks are targeting the same +environment.

+

If either stack.account or stack.region are not concrete values (e.g. +Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or +unknown-region will be used respectively to indicate this stack is +region/account-agnostic.

+
+
+
+

Optional Readonly nestedStackResource

+
nestedStackResource?: CfnResource
+

If this is a nested stack, this represents its AWS::CloudFormation::Stack +resource. undefined for top-level (non-nested) stacks.

+
+
+
+

Readonly node

+
node: Node
+

The tree node.

+
+
+
+

Readonly region

+
region: string
+

The AWS region into which this stack will be deployed (e.g. us-west-2).

+

This value is resolved according to the following rules:

+
    +
  1. The value provided to env.region when the stack is defined. This can +either be a concrete region (e.g. us-west-2) or the Aws.REGION +token.
    2. +
  2. Aws.REGION, which is represents the CloudFormation intrinsic reference +{ "Ref": "AWS::Region" } encoded as a string token.
    3. +
+

Preferably, you should use the return value as an opaque string and not +attempt to parse it to implement your logic. If you do, you must first +check that it is a concrete value an not an unresolved token. If this +value is an unresolved token (Token.isUnresolved(stack.region) returns +true), this implies that the user wishes that this stack will synthesize +into a region-agnostic template. In this case, your code should either +fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or +implement some other region-agnostic behavior.

+
+
+
+

Readonly synthesizer

+
synthesizer: IStackSynthesizer
+

Synthesis method for this stack

+
+
+
+

Readonly tags

+
tags: TagManager
+

Tags to be applied to the stack.

+
+
+
+

Readonly templateFile

+
templateFile: string
+

The name of the CloudFormation template file emitted to the output +directory during synthesis.

+

Example value: MyStack.template.json

+
+
+
+

Readonly templateOptions

+
templateOptions: ITemplateOptions
+

Options for CloudFormation template (like version, transform, description).

+
+
+
+

Optional Readonly terminationProtection

+
terminationProtection?: boolean
+

Whether termination protection is enabled for this stack.

+
+
+
+

Accessors

+
+

availabilityZones

+
    +
  • get availabilityZones(): string[]
    • +
  • +

    Returns the list of AZs that are available in the AWS environment +(account/region) associated with this stack.

    +

    If the stack is environment-agnostic (either account and/or region are +tokens), this property will return an array with 2 tokens that will resolve +at deploy-time to the first two availability zones returned from CloudFormation's +Fn::GetAZs intrinsic function.

    +

    If they are not available in the context, returns a set of dummy values and +reports them as missing, and let the CLI resolve them by calling EC2 +DescribeAvailabilityZones on the target environment.

    +

    To specify a different strategy for selecting availability zones override this method.

    +
    +

    Returns string[]

    +
+
+

bundlingRequired

+
    +
  • get bundlingRequired(): boolean
    • +
  • +

    Indicates whether the stack requires bundling or not

    +
    +

    Returns boolean

    +
+
+

dependencies

+
    +
  • get dependencies(): Stack[]
    • +
  • +

    Return the stacks this stack depends on

    +
    +

    Returns Stack[]

    +
+
+

Private maxResources

+
    +
  • get maxResources(): any
    • +
  • +

    Maximum number of resources in the stack

    +

    Set to 0 to mean "unlimited".

    +
    +

    Returns any

    +
+
+

nested

+
    +
  • get nested(): boolean
    • +
  • +

    Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

    +
    +

    Returns boolean

    +
+
+

nestedStackParent

+
    +
  • get nestedStackParent(): undefined | Stack
    • +
  • +

    If this is a nested stack, returns it's parent stack.

    +
    +

    Returns undefined | Stack

    +
+
+

notificationArns

+
    +
  • get notificationArns(): string[]
    • +
  • +

    Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

    +
    +

    Returns string[]

    +
+
+

partition

+
    +
  • get partition(): string
    • +
  • +

    The partition in which this stack is defined

    +
    +

    Returns string

    +
+
+

Private permissionsBoundaryArn

+
    +
  • get permissionsBoundaryArn(): any
    • +
  • +

    If a permissions boundary has been applied on this scope or any parent scope +then this will return the ARN of the permissions boundary.

    +

    This will return the permissions boundary that has been applied to the most +specific scope.

    +

    For example:

    +

    const stage = new Stage(app, 'stage', { + permissionsBoundary: PermissionsBoundary.fromName('stage-pb'), +});

    +

    const stack = new Stack(stage, 'Stack', { + permissionsBoundary: PermissionsBoundary.fromName('some-other-pb'), +});

    +

    Stack.permissionsBoundaryArn === 'arn:${AWS::Partition}:iam::${AWS::AccountId}:policy/some-other-pb';

    +
    +

    Returns any

    the name of the permissions boundary or undefined if not set

    + +
+
+

stackId

+
    +
  • get stackId(): string
    • +
  • +

    The ID of the stack

    +
    +

    Returns string

    +
    +

    Example

    // After resolving, looks like
    'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+
    +
+
+

stackName

+
    +
  • get stackName(): string
    • +
  • +

    The concrete CloudFormation physical stack name.

    +

    This is either the name defined explicitly in the stackName prop or +allocated based on the stack's location in the construct tree. Stacks that +are directly defined under the app use their construct id as their stack +name. Stacks that are defined deeper within the tree will use a hashed naming +scheme based on the construct path to ensure uniqueness.

    +

    If you wish to obtain the deploy-time AWS::StackName intrinsic, +you can use Aws.STACK_NAME directly.

    +
    +

    Returns string

    +
+
+

urlSuffix

+
    +
  • get urlSuffix(): string
    • +
  • +

    The Amazon domain suffix for the region in which this stack is defined

    +
    +

    Returns string

    +
+
+

Methods

+
+

_addAssemblyDependency

+
    +
  • _addAssemblyDependency(target, reason?): void
    • +
  • Internal +

    Called implicitly by the addDependency helper function in order to +realize a dependency between two top-level stacks at the assembly level.

    +

    Use stack.addDependency to define the dependency between any two stacks, +and take into account nested stack relationships.

    +
    +
    +

    Parameters

    +
      +
    • +
      target: Stack
      • +
    • +
      Optional reason: StackDependencyReason
    +

    Returns void

    +
+
+

_obtainAssemblyDependencies

+
    +
  • _obtainAssemblyDependencies(reasonFilter): Element[]
    • +
  • Internal +

    Called implicitly by the obtainDependencies helper function in order to +collect resource dependencies across two top-level stacks at the assembly level.

    +

    Use stack.obtainDependencies to see the dependencies between any two stacks.

    +
    +
    +

    Parameters

    +
      +
    • +
      reasonFilter: StackDependencyReason
    +

    Returns Element[]

    +
+
+

_removeAssemblyDependency

+
    +
  • _removeAssemblyDependency(target, reasonFilter?): void
    • +
  • Internal +

    Called implicitly by the removeDependency helper function in order to +remove a dependency between two top-level stacks at the assembly level.

    +

    Use stack.addDependency to define the dependency between any two stacks, +and take into account nested stack relationships.

    +
    +
    +

    Parameters

    +
      +
    • +
      target: Stack
      • +
    • +
      Optional reasonFilter: StackDependencyReason
    +

    Returns void

    +
+
+

_synthesizeTemplate

+
    +
  • _synthesizeTemplate(session, lookupRoleArn?): void
    • +
  • Internal +

    Synthesizes the cloudformation template into a cloud assembly.

    +
    +
    +

    Parameters

    +
      +
    • +
      session: ISynthesisSession
      • +
    • +
      Optional lookupRoleArn: string
    +

    Returns void

    +
+
+

Protected _toCloudFormation

+
    +
  • _toCloudFormation(): any
    • +
  • Internal +

    Returns the CloudFormation template for this stack by traversing +the tree and invoking _toCloudFormation() on all Entity objects.

    +
    +

    Returns any

    +
+
+

Protected _validateId

+
    +
  • _validateId(name): void
    • +
  • Internal +

    Validate stack name

    +

    CloudFormation stack names can include dashes in addition to the regular identifier +character classes, and we don't allow one of the magic markers.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
    +

    Returns void

    +
+
+

Private addAMIBackupPolicy

+
+
+

Private addAMIEBSBackupPolicy

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      region: string
    +

    Returns PolicyStatement

+
+

Private addAMIEC2EBSBackupPolicy

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      region: string
    +

    Returns PolicyStatement

+
+

Private addAMIS3BackupPolicy

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      artifactBucketArn: string
    +

    Returns PolicyStatement

+
+

addDependency

+
    + +
  • +

    Add a dependency between this stack and another stack.

    +

    This can be used to define dependencies between any two stacks within an +app, and also supports nested stacks.

    +
    +
    +

    Parameters

    +
      +
    • +
      target: Stack
      • +
    • +
      Optional reason: string
    +

    Returns void

    +
+
+

Private addFileSystem

+
    + +
  • +

    Adds an EFS FileSystem to the VPC and SecurityGroup.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
      +

      A name to differentiate the filesystem.

      +
      +
      • +
    • +
      vpc: IVpc
      +

      The VPC the Filesystem resides in.

      +
      +
      • +
    • +
      securityGroup: ISecurityGroup
      +

      A SecurityGroup to allow access to the filesystem from.

      +
      +
    +

    Returns string

    The filesystem location URL.

    + +
+
+

addMetadata

+
+
+

addTransform

+
    + +
  • +

    Add a Transform to this stack. A Transform is a macro that AWS +CloudFormation uses to process your template.

    +

    Duplicate values are removed when stack is synthesized.

    +
    +
    +

    Parameters

    +
      +
    • +
      transform: string
      +

      The transform to add

      +
      +
    +

    Returns void

    +
    +

    See

    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

    + +

    Example

    declare const stack: Stack;

    stack.addTransform('AWS::Serverless-2016-10-31')
+
    +
+
+

Private addVMExportPolicy

+
+
+

Protected allocateLogicalId

+
    + +
  • +

    Returns the naming scheme used to allocate logical IDs. By default, uses +the HashedAddressingScheme but this method can be overridden to customize +this behavior.

    +

    In order to make sure logical IDs are unique and stable, we hash the resource +construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as +a suffix to the path components joined without a separator (CloudFormation +IDs only allow alphanumeric characters).

    +

    The result will be:

    +

    <path.join('')><md5(path.join('/')> + "human" "hash"

    +

    If the "human" part of the ID exceeds 240 characters, we simply trim it so +the total ID doesn't exceed CloudFormation's 255 character limit.

    +

    We only take 8 characters from the md5 hash (0.000005 chance of collision).

    +

    Special cases:

    +
      +
    • If the path only contains a single component (i.e. it's a top-level +resource), we won't add the hash to it. The hash is not needed for +disambiguation and also, it allows for a more straightforward migration an +existing CloudFormation template to a CDK stack without logical ID changes +(or renames).
      • +
    • For aesthetic reasons, if the last components of the path are the same +(i.e. L1/L2/Pipeline/Pipeline), they will be de-duplicated to make the +resulting human portion of the ID more pleasing: L1L2Pipeline<HASH> +instead of L1L2PipelinePipeline<HASH>
      • +
    • If a component is named "Default" it will be omitted from the path. This +allows refactoring higher level abstractions around constructs without affecting +the IDs of already deployed resources.
      • +
    • If a component is named "Resource" it will be omitted from the user-visible +path, but included in the hash. This reduces visual noise in the human readable +part of the identifier.
      • +
    +
    +
    +

    Parameters

    +
      +
    • +
      cfnElement: CfnElement
      +

      The element for which the logical ID is allocated.

      +
      +
    +

    Returns string

    +
+
+

exportStringListValue

+
    + +
  • +

    Create a CloudFormation Export for a string list value

    +

    Returns a string list representing the corresponding Fn.importValue() +expression for this Export. The export expression is automatically wrapped with an +Fn::Join and the import value with an Fn::Split, since CloudFormation can only +export strings. You can control the name for the export by passing the name option.

    +

    If you don't supply a value for name, the value you're exporting must be +a Resource attribute (for example: bucket.bucketName) and it will be +given the same name as the automatic cross-stack reference that would be created +if you used the attribute in another Stack.

    +

    One of the uses for this method is to remove the relationship between +two Stacks established by automatic cross-stack references. It will +temporarily ensure that the CloudFormation Export still exists while you +remove the reference from the consuming stack. After that, you can remove +the resource and the manual export.

    +

    See exportValue for an example of this process.

    +
    +
    +

    Parameters

    +
      +
    • +
      exportedValue: any
      • +
    • +
      Optional options: ExportValueOptions
    +

    Returns string[]

    +
+
+

exportValue

+
    + +
  • +

    Create a CloudFormation Export for a string value

    +

    Returns a string representing the corresponding Fn.importValue() +expression for this Export. You can control the name for the export by +passing the name option.

    +

    If you don't supply a value for name, the value you're exporting must be +a Resource attribute (for example: bucket.bucketName) and it will be +given the same name as the automatic cross-stack reference that would be created +if you used the attribute in another Stack.

    +

    One of the uses for this method is to remove the relationship between +two Stacks established by automatic cross-stack references. It will +temporarily ensure that the CloudFormation Export still exists while you +remove the reference from the consuming stack. After that, you can remove +the resource and the manual export.

    +

    Example

    Here is how the process works. Let's say there are two stacks, +producerStack and consumerStack, and producerStack has a bucket +called bucket, which is referenced by consumerStack (perhaps because +an AWS Lambda Function writes into it, or something like that).

    +

    It is not safe to remove producerStack.bucket because as the bucket is being +deleted, consumerStack might still be using it.

    +

    Instead, the process takes two deployments:

    +

    Deployment 1: break the relationship

      +
    • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer +stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just +remove the Lambda Function altogether).
      • +
    • In the ProducerStack class, call this.exportValue(this.bucket.bucketName). This +will make sure the CloudFormation Export continues to exist while the relationship +between the two stacks is being broken.
      • +
    • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).
      • +
    +

    Deployment 2: remove the bucket resource

      +
    • You are now free to remove the bucket resource from producerStack.
      • +
    • Don't forget to remove the exportValue() call as well.
      • +
    • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
      • +
    +
    +
    +

    Parameters

    +
      +
    • +
      exportedValue: any
      • +
    • +
      Optional options: ExportValueOptions
    +

    Returns string

    +
+
+

formatArn

+
    + +
  • +

    Creates an ARN from components.

    +

    If partition, region or account are not specified, the stack's +partition, region and account will be used.

    +

    If any component is the empty string, an empty string will be inserted +into the generated ARN at the location that component corresponds to.

    +

    The ARN will be formatted as follows:

    +

    arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

    +

    The required ARN pieces that are omitted will be taken from the stack that +the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope +can be 'undefined'.

    +
    +
    +

    Parameters

    +
      +
    • +
      components: ArnComponents
    +

    Returns string

    +
+
+

getLogicalId

+
    + +
  • +

    Allocates a stack-unique CloudFormation-compatible logical identity for a +specific resource.

    +

    This method is called when a CfnElement is created and used to render the +initial logical identity of resources. Logical ID renames are applied at +this stage.

    +

    This method uses the protected method allocateLogicalId to render the +logical ID for an element. To modify the naming scheme, extend the Stack +class and override this method.

    +
    +
    +

    Parameters

    +
      +
    • +
      element: CfnElement
      +

      The CloudFormation element for which a logical identity is +needed.

      +
      +
    +

    Returns string

    +
+
+

regionalFact

+
    + +
  • +

    Look up a fact value for the given fact for the region of this stack

    +

    Will return a definite value only if the region of the current stack is resolved. +If not, a lookup map will be added to the stack and the lookup will be done at +CDK deployment time.

    +

    What regions will be included in the lookup map is controlled by the +@aws-cdk/core:target-partitions context value: it must be set to a list +of partitions, and only regions from the given partitions will be included. +If no such context key is set, all regions will be included.

    +

    This function is intended to be used by construct library authors. Application +builders can rely on the abstractions offered by construct libraries and do +not have to worry about regional facts.

    +

    If defaultValue is not given, it is an error if the fact is unknown for +the given region.

    +
    +
    +

    Parameters

    +
      +
    • +
      factName: string
      • +
    • +
      Optional defaultValue: string
    +

    Returns string

    +
+
+

renameLogicalId

+
    + +
  • +

    Rename a generated logical identities

    +

    To modify the naming scheme strategy, extend the Stack class and +override the allocateLogicalId method.

    +
    +
    +

    Parameters

    +
      +
    • +
      oldId: string
      • +
    • +
      newId: string
    +

    Returns void

    +
+
+

reportMissingContextKey

+
    + +
  • +

    Indicate that a context key was expected

    +

    Contains instructions which will be emitted into the cloud assembly on how +the key should be supplied.

    +
    +
    +

    Parameters

    +
      +
    • +
      report: MissingContext
      +

      The set of parameters needed to obtain the context

      +
      +
    +

    Returns void

    +
+
+

resolve

+
    + +
  • +

    Resolve a tokenized value in the context of the current stack.

    +
    +
    +

    Parameters

    +
      +
    • +
      obj: any
    +

    Returns any

    +
+
+

splitArn

+
    + +
  • +

    Splits the provided ARN into its components. +Works both if 'arn' is a string like 'arn:aws:s3:::bucket', +and a Token representing a dynamic CloudFormation expression +(in which case the returned components will also be dynamic CloudFormation expressions, +encoded as Tokens).

    +
    +
    +

    Parameters

    +
      +
    • +
      arn: string
      +

      the ARN to split into its components

      +
      +
      • +
    • +
      arnFormat: ArnFormat
      +

      the expected format of 'arn' - depends on what format the service 'arn' represents uses

      +
      +
    +

    Returns ArnComponents

    +
+
+

toJsonString

+
    + +
  • +

    Convert an object, potentially containing tokens, to a JSON string

    +
    +
    +

    Parameters

    +
      +
    • +
      obj: any
      • +
    • +
      Optional space: number
    +

    Returns string

    +
+
+

toString

+
    + +
  • +

    Returns a string representation of this construct.

    +
    +

    Returns string

    +
+
+

toYamlString

+
    + +
  • +

    Convert an object, potentially containing tokens, to a YAML string

    +
    +
    +

    Parameters

    +
      +
    • +
      obj: any
    +

    Returns string

    +
+
+

Static isConstruct

+
    + +
  • +

    Checks if x is a construct.

    +

    Use this method instead of instanceof to properly detect Construct +instances, even when the construct library is symlinked.

    +

    Explanation: in JavaScript, multiple copies of the constructs library on +disk are seen as independent, completely different libraries. As a +consequence, the class Construct in each copy of the constructs library +is seen as a different class, and an instance of one class will not test as +instanceof the other class. npm install will not create installations +like this, but users may manually symlink construct libraries together or +use a monorepo tool: in those cases, multiple copies of the constructs +library can be accidentally installed, and instanceof will behave +unpredictably. It is safest to avoid using instanceof, and using +this type-testing method instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: any
      +

      Any object

      +
      +
    +

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

    + +
+
+

Static isStack

+
    + +
  • +

    Return whether the given object is a Stack.

    +

    We do attribute detection since we can't reliably use 'instanceof'.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: any
    +

    Returns x is Stack

    +
+
+

Static of

+
    + +
  • +

    Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

    +
    +
    +

    Parameters

    +
      +
    • +
      construct: IConstruct
      +

      The construct to start the search from.

      +
      +
    +

    Returns Stack

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/classes/PipelineNetworkStack.html b/classes/PipelineNetworkStack.html new file mode 100644 index 0000000..481a8cd --- /dev/null +++ b/classes/PipelineNetworkStack.html @@ -0,0 +1,1177 @@ +PipelineNetworkStack | aws4embeddedlinux-cdk-lib
+
+ +
+
+
+
+ +

Class PipelineNetworkStack

+
+

The network resources to run the pipeline in.

+
+
+
+

Hierarchy

+
    +
  • Stack +
      +
    • PipelineNetworkStack
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_crossRegionReferences +_versionReportingEnabled +account +artifactId +environment +nestedStackResource? +node +region +synthesizer +tags +templateFile +templateOptions +terminationProtection? +vpc +
+
+

Accessors

+
availabilityZones +bundlingRequired +dependencies +maxResources +nested +nestedStackParent +notificationArns +partition +permissionsBoundaryArn +stackId +stackName +urlSuffix +
+
+

Methods

+
_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate +_toCloudFormation +_validateId +addDependency +addMetadata +addTransform +allocateLogicalId +exportStringListValue +exportValue +formatArn +getLogicalId +regionalFact +renameLogicalId +reportMissingContextKey +resolve +splitArn +toJsonString +toString +toYamlString +isConstruct +isStack +of +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly Internal _crossRegionReferences

+
_crossRegionReferences: boolean
+

Whether cross region references are enabled for this stack

+
+
+
+

Readonly Internal _versionReportingEnabled

+
_versionReportingEnabled: boolean
+

Whether version reporting is enabled for this stack

+

Controls whether the CDK Metadata resource is injected

+
+
+
+

Readonly account

+
account: string
+

The AWS account into which this stack will be deployed.

+

This value is resolved according to the following rules:

+
    +
  1. The value provided to env.account when the stack is defined. This can +either be a concrete account (e.g. 585695031111) or the +Aws.ACCOUNT_ID token.
    2. +
  2. Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference +{ "Ref": "AWS::AccountId" } encoded as a string token.
    3. +
+

Preferably, you should use the return value as an opaque string and not +attempt to parse it to implement your logic. If you do, you must first +check that it is a concrete value an not an unresolved token. If this +value is an unresolved token (Token.isUnresolved(stack.account) returns +true), this implies that the user wishes that this stack will synthesize +into a account-agnostic template. In this case, your code should either +fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or +implement some other region-agnostic behavior.

+
+
+
+

Readonly artifactId

+
artifactId: string
+

The ID of the cloud assembly artifact for this stack.

+
+
+
+

Readonly environment

+
environment: string
+

The environment coordinates in which this stack is deployed. In the form +aws://account/region. Use stack.account and stack.region to obtain +the specific values, no need to parse.

+

You can use this value to determine if two stacks are targeting the same +environment.

+

If either stack.account or stack.region are not concrete values (e.g. +Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or +unknown-region will be used respectively to indicate this stack is +region/account-agnostic.

+
+
+
+

Optional Readonly nestedStackResource

+
nestedStackResource?: CfnResource
+

If this is a nested stack, this represents its AWS::CloudFormation::Stack +resource. undefined for top-level (non-nested) stacks.

+
+
+
+

Readonly node

+
node: Node
+

The tree node.

+
+
+
+

Readonly region

+
region: string
+

The AWS region into which this stack will be deployed (e.g. us-west-2).

+

This value is resolved according to the following rules:

+
    +
  1. The value provided to env.region when the stack is defined. This can +either be a concrete region (e.g. us-west-2) or the Aws.REGION +token.
    2. +
  2. Aws.REGION, which is represents the CloudFormation intrinsic reference +{ "Ref": "AWS::Region" } encoded as a string token.
    3. +
+

Preferably, you should use the return value as an opaque string and not +attempt to parse it to implement your logic. If you do, you must first +check that it is a concrete value an not an unresolved token. If this +value is an unresolved token (Token.isUnresolved(stack.region) returns +true), this implies that the user wishes that this stack will synthesize +into a region-agnostic template. In this case, your code should either +fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or +implement some other region-agnostic behavior.

+
+
+
+

Readonly synthesizer

+
synthesizer: IStackSynthesizer
+

Synthesis method for this stack

+
+
+
+

Readonly tags

+
tags: TagManager
+

Tags to be applied to the stack.

+
+
+
+

Readonly templateFile

+
templateFile: string
+

The name of the CloudFormation template file emitted to the output +directory during synthesis.

+

Example value: MyStack.template.json

+
+
+
+

Readonly templateOptions

+
templateOptions: ITemplateOptions
+

Options for CloudFormation template (like version, transform, description).

+
+
+
+

Optional Readonly terminationProtection

+
terminationProtection?: boolean
+

Whether termination protection is enabled for this stack.

+
+
+
+

Readonly vpc

+
vpc: IVpc
+

The VPC for the pipeline to reside in.

+
+
+
+

Accessors

+
+

availabilityZones

+
    +
  • get availabilityZones(): string[]
    • +
  • +

    Returns the list of AZs that are available in the AWS environment +(account/region) associated with this stack.

    +

    If the stack is environment-agnostic (either account and/or region are +tokens), this property will return an array with 2 tokens that will resolve +at deploy-time to the first two availability zones returned from CloudFormation's +Fn::GetAZs intrinsic function.

    +

    If they are not available in the context, returns a set of dummy values and +reports them as missing, and let the CLI resolve them by calling EC2 +DescribeAvailabilityZones on the target environment.

    +

    To specify a different strategy for selecting availability zones override this method.

    +
    +

    Returns string[]

    +
+
+

bundlingRequired

+
    +
  • get bundlingRequired(): boolean
    • +
  • +

    Indicates whether the stack requires bundling or not

    +
    +

    Returns boolean

    +
+
+

dependencies

+
    +
  • get dependencies(): Stack[]
    • +
  • +

    Return the stacks this stack depends on

    +
    +

    Returns Stack[]

    +
+
+

Private maxResources

+
    +
  • get maxResources(): any
    • +
  • +

    Maximum number of resources in the stack

    +

    Set to 0 to mean "unlimited".

    +
    +

    Returns any

    +
+
+

nested

+
    +
  • get nested(): boolean
    • +
  • +

    Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

    +
    +

    Returns boolean

    +
+
+

nestedStackParent

+
    +
  • get nestedStackParent(): undefined | Stack
    • +
  • +

    If this is a nested stack, returns it's parent stack.

    +
    +

    Returns undefined | Stack

    +
+
+

notificationArns

+
    +
  • get notificationArns(): string[]
    • +
  • +

    Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

    +
    +

    Returns string[]

    +
+
+

partition

+
    +
  • get partition(): string
    • +
  • +

    The partition in which this stack is defined

    +
    +

    Returns string

    +
+
+

Private permissionsBoundaryArn

+
    +
  • get permissionsBoundaryArn(): any
    • +
  • +

    If a permissions boundary has been applied on this scope or any parent scope +then this will return the ARN of the permissions boundary.

    +

    This will return the permissions boundary that has been applied to the most +specific scope.

    +

    For example:

    +

    const stage = new Stage(app, 'stage', { + permissionsBoundary: PermissionsBoundary.fromName('stage-pb'), +});

    +

    const stack = new Stack(stage, 'Stack', { + permissionsBoundary: PermissionsBoundary.fromName('some-other-pb'), +});

    +

    Stack.permissionsBoundaryArn === 'arn:${AWS::Partition}:iam::${AWS::AccountId}:policy/some-other-pb';

    +
    +

    Returns any

    the name of the permissions boundary or undefined if not set

    + +
+
+

stackId

+
    +
  • get stackId(): string
    • +
  • +

    The ID of the stack

    +
    +

    Returns string

    +
    +

    Example

    // After resolving, looks like
    'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+
    +
+
+

stackName

+
    +
  • get stackName(): string
    • +
  • +

    The concrete CloudFormation physical stack name.

    +

    This is either the name defined explicitly in the stackName prop or +allocated based on the stack's location in the construct tree. Stacks that +are directly defined under the app use their construct id as their stack +name. Stacks that are defined deeper within the tree will use a hashed naming +scheme based on the construct path to ensure uniqueness.

    +

    If you wish to obtain the deploy-time AWS::StackName intrinsic, +you can use Aws.STACK_NAME directly.

    +
    +

    Returns string

    +
+
+

urlSuffix

+
    +
  • get urlSuffix(): string
    • +
  • +

    The Amazon domain suffix for the region in which this stack is defined

    +
    +

    Returns string

    +
+
+

Methods

+
+

_addAssemblyDependency

+
    +
  • _addAssemblyDependency(target, reason?): void
    • +
  • Internal +

    Called implicitly by the addDependency helper function in order to +realize a dependency between two top-level stacks at the assembly level.

    +

    Use stack.addDependency to define the dependency between any two stacks, +and take into account nested stack relationships.

    +
    +
    +

    Parameters

    +
      +
    • +
      target: Stack
      • +
    • +
      Optional reason: StackDependencyReason
    +

    Returns void

    +
+
+

_obtainAssemblyDependencies

+
    +
  • _obtainAssemblyDependencies(reasonFilter): Element[]
    • +
  • Internal +

    Called implicitly by the obtainDependencies helper function in order to +collect resource dependencies across two top-level stacks at the assembly level.

    +

    Use stack.obtainDependencies to see the dependencies between any two stacks.

    +
    +
    +

    Parameters

    +
      +
    • +
      reasonFilter: StackDependencyReason
    +

    Returns Element[]

    +
+
+

_removeAssemblyDependency

+
    +
  • _removeAssemblyDependency(target, reasonFilter?): void
    • +
  • Internal +

    Called implicitly by the removeDependency helper function in order to +remove a dependency between two top-level stacks at the assembly level.

    +

    Use stack.addDependency to define the dependency between any two stacks, +and take into account nested stack relationships.

    +
    +
    +

    Parameters

    +
      +
    • +
      target: Stack
      • +
    • +
      Optional reasonFilter: StackDependencyReason
    +

    Returns void

    +
+
+

_synthesizeTemplate

+
    +
  • _synthesizeTemplate(session, lookupRoleArn?): void
    • +
  • Internal +

    Synthesizes the cloudformation template into a cloud assembly.

    +
    +
    +

    Parameters

    +
      +
    • +
      session: ISynthesisSession
      • +
    • +
      Optional lookupRoleArn: string
    +

    Returns void

    +
+
+

Protected _toCloudFormation

+
    +
  • _toCloudFormation(): any
    • +
  • Internal +

    Returns the CloudFormation template for this stack by traversing +the tree and invoking _toCloudFormation() on all Entity objects.

    +
    +

    Returns any

    +
+
+

Protected _validateId

+
    +
  • _validateId(name): void
    • +
  • Internal +

    Validate stack name

    +

    CloudFormation stack names can include dashes in addition to the regular identifier +character classes, and we don't allow one of the magic markers.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
    +

    Returns void

    +
+
+

addDependency

+
    + +
  • +

    Add a dependency between this stack and another stack.

    +

    This can be used to define dependencies between any two stacks within an +app, and also supports nested stacks.

    +
    +
    +

    Parameters

    +
      +
    • +
      target: Stack
      • +
    • +
      Optional reason: string
    +

    Returns void

    +
+
+

addMetadata

+
+
+

addTransform

+
    + +
  • +

    Add a Transform to this stack. A Transform is a macro that AWS +CloudFormation uses to process your template.

    +

    Duplicate values are removed when stack is synthesized.

    +
    +
    +

    Parameters

    +
      +
    • +
      transform: string
      +

      The transform to add

      +
      +
    +

    Returns void

    +
    +

    See

    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

    + +

    Example

    declare const stack: Stack;

    stack.addTransform('AWS::Serverless-2016-10-31')
+
    +
+
+

Protected allocateLogicalId

+
    + +
  • +

    Returns the naming scheme used to allocate logical IDs. By default, uses +the HashedAddressingScheme but this method can be overridden to customize +this behavior.

    +

    In order to make sure logical IDs are unique and stable, we hash the resource +construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as +a suffix to the path components joined without a separator (CloudFormation +IDs only allow alphanumeric characters).

    +

    The result will be:

    +

    <path.join('')><md5(path.join('/')> + "human" "hash"

    +

    If the "human" part of the ID exceeds 240 characters, we simply trim it so +the total ID doesn't exceed CloudFormation's 255 character limit.

    +

    We only take 8 characters from the md5 hash (0.000005 chance of collision).

    +

    Special cases:

    +
      +
    • If the path only contains a single component (i.e. it's a top-level +resource), we won't add the hash to it. The hash is not needed for +disambiguation and also, it allows for a more straightforward migration an +existing CloudFormation template to a CDK stack without logical ID changes +(or renames).
      • +
    • For aesthetic reasons, if the last components of the path are the same +(i.e. L1/L2/Pipeline/Pipeline), they will be de-duplicated to make the +resulting human portion of the ID more pleasing: L1L2Pipeline<HASH> +instead of L1L2PipelinePipeline<HASH>
      • +
    • If a component is named "Default" it will be omitted from the path. This +allows refactoring higher level abstractions around constructs without affecting +the IDs of already deployed resources.
      • +
    • If a component is named "Resource" it will be omitted from the user-visible +path, but included in the hash. This reduces visual noise in the human readable +part of the identifier.
      • +
    +
    +
    +

    Parameters

    +
      +
    • +
      cfnElement: CfnElement
      +

      The element for which the logical ID is allocated.

      +
      +
    +

    Returns string

    +
+
+

exportStringListValue

+
    + +
  • +

    Create a CloudFormation Export for a string list value

    +

    Returns a string list representing the corresponding Fn.importValue() +expression for this Export. The export expression is automatically wrapped with an +Fn::Join and the import value with an Fn::Split, since CloudFormation can only +export strings. You can control the name for the export by passing the name option.

    +

    If you don't supply a value for name, the value you're exporting must be +a Resource attribute (for example: bucket.bucketName) and it will be +given the same name as the automatic cross-stack reference that would be created +if you used the attribute in another Stack.

    +

    One of the uses for this method is to remove the relationship between +two Stacks established by automatic cross-stack references. It will +temporarily ensure that the CloudFormation Export still exists while you +remove the reference from the consuming stack. After that, you can remove +the resource and the manual export.

    +

    See exportValue for an example of this process.

    +
    +
    +

    Parameters

    +
      +
    • +
      exportedValue: any
      • +
    • +
      Optional options: ExportValueOptions
    +

    Returns string[]

    +
+
+

exportValue

+
    + +
  • +

    Create a CloudFormation Export for a string value

    +

    Returns a string representing the corresponding Fn.importValue() +expression for this Export. You can control the name for the export by +passing the name option.

    +

    If you don't supply a value for name, the value you're exporting must be +a Resource attribute (for example: bucket.bucketName) and it will be +given the same name as the automatic cross-stack reference that would be created +if you used the attribute in another Stack.

    +

    One of the uses for this method is to remove the relationship between +two Stacks established by automatic cross-stack references. It will +temporarily ensure that the CloudFormation Export still exists while you +remove the reference from the consuming stack. After that, you can remove +the resource and the manual export.

    +

    Example

    Here is how the process works. Let's say there are two stacks, +producerStack and consumerStack, and producerStack has a bucket +called bucket, which is referenced by consumerStack (perhaps because +an AWS Lambda Function writes into it, or something like that).

    +

    It is not safe to remove producerStack.bucket because as the bucket is being +deleted, consumerStack might still be using it.

    +

    Instead, the process takes two deployments:

    +

    Deployment 1: break the relationship

      +
    • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer +stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just +remove the Lambda Function altogether).
      • +
    • In the ProducerStack class, call this.exportValue(this.bucket.bucketName). This +will make sure the CloudFormation Export continues to exist while the relationship +between the two stacks is being broken.
      • +
    • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).
      • +
    +

    Deployment 2: remove the bucket resource

      +
    • You are now free to remove the bucket resource from producerStack.
      • +
    • Don't forget to remove the exportValue() call as well.
      • +
    • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
      • +
    +
    +
    +

    Parameters

    +
      +
    • +
      exportedValue: any
      • +
    • +
      Optional options: ExportValueOptions
    +

    Returns string

    +
+
+

formatArn

+
    + +
  • +

    Creates an ARN from components.

    +

    If partition, region or account are not specified, the stack's +partition, region and account will be used.

    +

    If any component is the empty string, an empty string will be inserted +into the generated ARN at the location that component corresponds to.

    +

    The ARN will be formatted as follows:

    +

    arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

    +

    The required ARN pieces that are omitted will be taken from the stack that +the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope +can be 'undefined'.

    +
    +
    +

    Parameters

    +
      +
    • +
      components: ArnComponents
    +

    Returns string

    +
+
+

getLogicalId

+
    + +
  • +

    Allocates a stack-unique CloudFormation-compatible logical identity for a +specific resource.

    +

    This method is called when a CfnElement is created and used to render the +initial logical identity of resources. Logical ID renames are applied at +this stage.

    +

    This method uses the protected method allocateLogicalId to render the +logical ID for an element. To modify the naming scheme, extend the Stack +class and override this method.

    +
    +
    +

    Parameters

    +
      +
    • +
      element: CfnElement
      +

      The CloudFormation element for which a logical identity is +needed.

      +
      +
    +

    Returns string

    +
+
+

regionalFact

+
    + +
  • +

    Look up a fact value for the given fact for the region of this stack

    +

    Will return a definite value only if the region of the current stack is resolved. +If not, a lookup map will be added to the stack and the lookup will be done at +CDK deployment time.

    +

    What regions will be included in the lookup map is controlled by the +@aws-cdk/core:target-partitions context value: it must be set to a list +of partitions, and only regions from the given partitions will be included. +If no such context key is set, all regions will be included.

    +

    This function is intended to be used by construct library authors. Application +builders can rely on the abstractions offered by construct libraries and do +not have to worry about regional facts.

    +

    If defaultValue is not given, it is an error if the fact is unknown for +the given region.

    +
    +
    +

    Parameters

    +
      +
    • +
      factName: string
      • +
    • +
      Optional defaultValue: string
    +

    Returns string

    +
+
+

renameLogicalId

+
    + +
  • +

    Rename a generated logical identities

    +

    To modify the naming scheme strategy, extend the Stack class and +override the allocateLogicalId method.

    +
    +
    +

    Parameters

    +
      +
    • +
      oldId: string
      • +
    • +
      newId: string
    +

    Returns void

    +
+
+

reportMissingContextKey

+
    + +
  • +

    Indicate that a context key was expected

    +

    Contains instructions which will be emitted into the cloud assembly on how +the key should be supplied.

    +
    +
    +

    Parameters

    +
      +
    • +
      report: MissingContext
      +

      The set of parameters needed to obtain the context

      +
      +
    +

    Returns void

    +
+
+

resolve

+
    + +
  • +

    Resolve a tokenized value in the context of the current stack.

    +
    +
    +

    Parameters

    +
      +
    • +
      obj: any
    +

    Returns any

    +
+
+

splitArn

+
    + +
  • +

    Splits the provided ARN into its components. +Works both if 'arn' is a string like 'arn:aws:s3:::bucket', +and a Token representing a dynamic CloudFormation expression +(in which case the returned components will also be dynamic CloudFormation expressions, +encoded as Tokens).

    +
    +
    +

    Parameters

    +
      +
    • +
      arn: string
      +

      the ARN to split into its components

      +
      +
      • +
    • +
      arnFormat: ArnFormat
      +

      the expected format of 'arn' - depends on what format the service 'arn' represents uses

      +
      +
    +

    Returns ArnComponents

    +
+
+

toJsonString

+
    + +
  • +

    Convert an object, potentially containing tokens, to a JSON string

    +
    +
    +

    Parameters

    +
      +
    • +
      obj: any
      • +
    • +
      Optional space: number
    +

    Returns string

    +
+
+

toString

+
    + +
  • +

    Returns a string representation of this construct.

    +
    +

    Returns string

    +
+
+

toYamlString

+
    + +
  • +

    Convert an object, potentially containing tokens, to a YAML string

    +
    +
    +

    Parameters

    +
      +
    • +
      obj: any
    +

    Returns string

    +
+
+

Static isConstruct

+
    + +
  • +

    Checks if x is a construct.

    +

    Use this method instead of instanceof to properly detect Construct +instances, even when the construct library is symlinked.

    +

    Explanation: in JavaScript, multiple copies of the constructs library on +disk are seen as independent, completely different libraries. As a +consequence, the class Construct in each copy of the constructs library +is seen as a different class, and an instance of one class will not test as +instanceof the other class. npm install will not create installations +like this, but users may manually symlink construct libraries together or +use a monorepo tool: in those cases, multiple copies of the constructs +library can be accidentally installed, and instanceof will behave +unpredictably. It is safest to avoid using instanceof, and using +this type-testing method instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: any
      +

      Any object

      +
      +
    +

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

    + +
+
+

Static isStack

+
    + +
  • +

    Return whether the given object is a Stack.

    +

    We do attribute detection since we can't reliably use 'instanceof'.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: any
    +

    Returns x is Stack

    +
+
+

Static of

+
    + +
  • +

    Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

    +
    +
    +

    Parameters

    +
      +
    • +
      construct: IConstruct
      +

      The construct to start the search from.

      +
      +
    +

    Returns Stack

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html new file mode 100644 index 0000000..43590c4 --- /dev/null +++ b/classes/SourceRepo.html @@ -0,0 +1,176 @@ +SourceRepo | aws4embeddedlinux-cdk-lib
+
+ +
+
+
+
+ +

Class SourceRepo

+
+

The repository for the Source Stage of the pipeline.

+
+
+
+

Hierarchy

+
    +
  • Construct +
      +
    • SourceRepo
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
node +repo +
+
+

Methods

+
toString +isConstruct +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly node

+
node: Node
+

The tree node.

+
+
+
+

Readonly repo

+
repo: Repository
+

The CodeCommit Repo itself.

+
+
+
+

Methods

+
+

toString

+
    + +
  • +

    Returns a string representation of this construct.

    +
    +

    Returns string

    +
+
+

Static isConstruct

+
    + +
  • +

    Checks if x is a construct.

    +

    Use this method instead of instanceof to properly detect Construct +instances, even when the construct library is symlinked.

    +

    Explanation: in JavaScript, multiple copies of the constructs library on +disk are seen as independent, completely different libraries. As a +consequence, the class Construct in each copy of the constructs library +is seen as a different class, and an instance of one class will not test as +instanceof the other class. npm install will not create installations +like this, but users may manually symlink construct libraries together or +use a monorepo tool: in those cases, multiple copies of the constructs +library can be accidentally installed, and instanceof will behave +unpredictably. It is safest to avoid using instanceof, and using +this type-testing method instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: any
      +

      Any object

      +
      +
    +

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/enums/ImageKind.html b/enums/ImageKind.html new file mode 100644 index 0000000..164dcbe --- /dev/null +++ b/enums/ImageKind.html @@ -0,0 +1,100 @@ +ImageKind | aws4embeddedlinux-cdk-lib
+
+ +
+
+
+
+ +

Enumeration ImageKind

+
+

The type of Image to build on.

+
+
+
+
+
+ +
+
+

Enumeration Members

+
Debian11 +Fedora37 +Ubuntu22_04 +
+
+

Enumeration Members

+
+

Debian11

+
Debian11: "debian_11"
+

Debian GNU/Linux 11.x (Bullseye)

+
+
+
+

Fedora37

+
Fedora37: "fedora_37"
+

Fedora 37

+
+
+
+

Ubuntu22_04

+
Ubuntu22_04: "ubuntu_22_04"
+

Ubuntu 22.04 (LTS)

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html new file mode 100644 index 0000000..14bd16b --- /dev/null +++ b/enums/ProjectKind.html @@ -0,0 +1,120 @@ +ProjectKind | aws4embeddedlinux-cdk-lib
+
+ +
+
+
+
+ +

Enumeration ProjectKind

+
+

The kind of project built.

+
+
+
+
+
+ +
+
+

Enumeration Members

+
Kas +MetaAwsDemo +Poky +PokyAmi +Renesas +
+
+

Enumeration Members

+
+

Kas

+
Kas: "kas"
+

Build an kas based image

+
+
+
+

MetaAwsDemo

+
MetaAwsDemo: "meta-aws-demo"
+

Build the Qemu meta-aws Demonstration Distribution.

+
+
+
+

Poky

+
Poky: "poky"
+

Build core-image-minimal from poky.

+
+
+
+

PokyAmi

+
PokyAmi: "poky-ami"
+

Build an EC2 AMI

+
+
+
+

Renesas

+
Renesas: "renesas"
+

Build an Renesas image

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 0000000..5d40833 --- /dev/null +++ b/index.html @@ -0,0 +1,71 @@ +aws4embeddedlinux-cdk-lib
+
+ +
+
+
+
+

aws4embeddedlinux-cdk-lib

+
+
+

Index

+
+

Enumerations

+
ImageKind +ProjectKind +
+
+

Classes

+
BuildImageDataStack +BuildImagePipelineStack +BuildImageRepoStack +DemoPipelineStack +PipelineNetworkStack +SourceRepo +
+
+

Interfaces

+
BuildImageDataProps +BuildImagePipelineProps +DemoPipelineProps +SourceRepoProps +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html new file mode 100644 index 0000000..8c6a212 --- /dev/null +++ b/interfaces/BuildImageDataProps.html @@ -0,0 +1,270 @@ +BuildImageDataProps | aws4embeddedlinux-cdk-lib
+
+ +
+
+
+
+ +

Interface BuildImageDataProps

+
+

Select options for the BuildImageDataStack.

+
+
+
+

Hierarchy

+
    +
  • StackProps +
      +
    • BuildImageDataProps
+
+
+
+ +
+
+

Properties

+
analyticsReporting? +bucketName +crossRegionReferences? +description? +env? +permissionsBoundary? +stackName? +suppressTemplateIndentation? +synthesizer? +tags? +terminationProtection? +
+
+

Properties

+
+

Optional Readonly analyticsReporting

+
analyticsReporting?: boolean
+

Include runtime versioning information in this Stack

+
+
+

Default

analyticsReporting setting of containing App, or value of +'aws:cdk:version-reporting' context key

+
+
+

Readonly bucketName

+
bucketName: string
+

The bucket name for image build sources. This must be globally unique.

+
+
+
+

Optional Readonly crossRegionReferences

+
crossRegionReferences?: boolean
+

Enable this flag to allow native cross region stack references.

+

Enabling this will create a CloudFormation custom resource +in both the producing stack and consuming stack in order to perform the export/import

+

This feature is currently experimental

+
+
+

Default

false
+
+
+
+

Optional Readonly description

+
description?: string
+

A description of the stack.

+
+
+

Default

- No description.
+
+
+
+

Optional Readonly env

+
env?: Environment
+

The AWS environment (account/region) where this stack will be deployed.

+

Set the region/account fields of env to either a concrete value to +select the indicated environment (recommended for production stacks), or to +the values of environment variables +CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment +depend on the AWS credentials/configuration that the CDK CLI is executed +under (recommended for development stacks).

+

If the Stack is instantiated inside a Stage, any undefined +region/account fields from env will default to the same field on the +encompassing Stage, if configured there.

+

If either region or account are not set nor inherited from Stage, the +Stack will be considered "environment-agnostic"". Environment-agnostic +stacks can be deployed to any environment but may not be able to take +advantage of all features of the CDK. For example, they will not be able to +use environmental context lookups such as ec2.Vpc.fromLookup and will not +automatically translate Service Principals to the right format based on the +environment's AWS partition, and other such enhancements.

+
+
+

Example

// Use a concrete account and region to deploy this stack to:
// `.account` and `.region` will simply return these values.
new Stack(app, 'Stack1', {
  env: {
    account: '123456789012',
    region: 'us-east-1'
  },
});

// Use the CLI's current credentials to determine the target environment:
// `.account` and `.region` will reflect the account+region the CLI
// is configured to use (based on the user CLI credentials)
new Stack(app, 'Stack2', {
  env: {
    account: process.env.CDK_DEFAULT_ACCOUNT,
    region: process.env.CDK_DEFAULT_REGION
  },
});

// Define multiple stacks stage associated with an environment
const myStage = new Stage(app, 'MyStage', {
  env: {
    account: '123456789012',
    region: 'us-east-1'
  }
});

// both of these stacks will use the stage's account/region:
// `.account` and `.region` will resolve to the concrete values as above
new MyStack(myStage, 'Stack1');
new YourStack(myStage, 'Stack2');

// Define an environment-agnostic stack:
// `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
// which will only resolve to actual values by CloudFormation during deployment.
new MyStack(app, 'Stack1');
+
+ +

Default

    +
  • The environment of the containing Stage if available, +otherwise create the stack will be environment-agnostic.
    • +
+
+
+

Optional Readonly permissionsBoundary

+
permissionsBoundary?: PermissionsBoundary
+

Options for applying a permissions boundary to all IAM Roles +and Users created within this Stage

+
+
+

Default

- no permissions boundary is applied
+
+
+
+

Optional Readonly stackName

+
stackName?: string
+

Name to deploy the stack with

+
+
+

Default

- Derived from construct path.
+
+
+
+

Optional Readonly suppressTemplateIndentation

+
suppressTemplateIndentation?: boolean
+

Enable this flag to suppress indentation in generated +CloudFormation templates.

+

If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation +context key will be used. If that is not specified, then the +default value false will be used.

+
+
+

Default

    +
  • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
    • +
+
+
+

Optional Readonly synthesizer

+
synthesizer?: IStackSynthesizer
+

Synthesis method to use while deploying this stack

+

The Stack Synthesizer controls aspects of synthesis and deployment, +like how assets are referenced and what IAM roles to use. For more +information, see the README of the main CDK package.

+

If not specified, the defaultStackSynthesizer from App will be used. +If that is not specified, DefaultStackSynthesizer is used if +@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major +version is v2. In CDK v1 LegacyStackSynthesizer is the default if no +other synthesizer is specified.

+
+
+

Default

    +
  • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
    • +
+
+
+

Optional Readonly tags

+
tags?: {
    [key: string]: string;
}
+

Stack tags that will be applied to all the taggable resources and the stack itself.

+
+
+

Type declaration

+
    +
  • +
    [key: string]: string
+
+

Default

{}
+
+
+
+

Optional Readonly terminationProtection

+
terminationProtection?: boolean
+

Whether to enable termination protection for this stack.

+
+
+

Default

false
+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/interfaces/BuildImagePipelineProps.html b/interfaces/BuildImagePipelineProps.html new file mode 100644 index 0000000..65d8eec --- /dev/null +++ b/interfaces/BuildImagePipelineProps.html @@ -0,0 +1,290 @@ +BuildImagePipelineProps | aws4embeddedlinux-cdk-lib
+
+ +
+
+
+
+ +

Interface BuildImagePipelineProps

+
+

Select options for the BuildImagePipelineStack.

+
+
+
+

Hierarchy

+
    +
  • StackProps +
      +
    • BuildImagePipelineProps
+
+
+
+ +
+
+

Properties

+
analyticsReporting? +crossRegionReferences? +dataBucket +description? +env? +imageKind +permissionsBoundary? +repository +stackName? +suppressTemplateIndentation? +synthesizer? +tags? +terminationProtection? +
+
+

Properties

+
+

Optional Readonly analyticsReporting

+
analyticsReporting?: boolean
+

Include runtime versioning information in this Stack

+
+
+

Default

analyticsReporting setting of containing App, or value of +'aws:cdk:version-reporting' context key

+
+
+

Optional Readonly crossRegionReferences

+
crossRegionReferences?: boolean
+

Enable this flag to allow native cross region stack references.

+

Enabling this will create a CloudFormation custom resource +in both the producing stack and consuming stack in order to perform the export/import

+

This feature is currently experimental

+
+
+

Default

false
+
+
+
+

Readonly dataBucket

+
dataBucket: IBucket
+

The data bucket from the BuildImageDataStack

+
+
+
+

Optional Readonly description

+
description?: string
+

A description of the stack.

+
+
+

Default

- No description.
+
+
+
+

Optional Readonly env

+
env?: Environment
+

The AWS environment (account/region) where this stack will be deployed.

+

Set the region/account fields of env to either a concrete value to +select the indicated environment (recommended for production stacks), or to +the values of environment variables +CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment +depend on the AWS credentials/configuration that the CDK CLI is executed +under (recommended for development stacks).

+

If the Stack is instantiated inside a Stage, any undefined +region/account fields from env will default to the same field on the +encompassing Stage, if configured there.

+

If either region or account are not set nor inherited from Stage, the +Stack will be considered "environment-agnostic"". Environment-agnostic +stacks can be deployed to any environment but may not be able to take +advantage of all features of the CDK. For example, they will not be able to +use environmental context lookups such as ec2.Vpc.fromLookup and will not +automatically translate Service Principals to the right format based on the +environment's AWS partition, and other such enhancements.

+
+
+

Example

// Use a concrete account and region to deploy this stack to:
// `.account` and `.region` will simply return these values.
new Stack(app, 'Stack1', {
  env: {
    account: '123456789012',
    region: 'us-east-1'
  },
});

// Use the CLI's current credentials to determine the target environment:
// `.account` and `.region` will reflect the account+region the CLI
// is configured to use (based on the user CLI credentials)
new Stack(app, 'Stack2', {
  env: {
    account: process.env.CDK_DEFAULT_ACCOUNT,
    region: process.env.CDK_DEFAULT_REGION
  },
});

// Define multiple stacks stage associated with an environment
const myStage = new Stage(app, 'MyStage', {
  env: {
    account: '123456789012',
    region: 'us-east-1'
  }
});

// both of these stacks will use the stage's account/region:
// `.account` and `.region` will resolve to the concrete values as above
new MyStack(myStage, 'Stack1');
new YourStack(myStage, 'Stack2');

// Define an environment-agnostic stack:
// `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
// which will only resolve to actual values by CloudFormation during deployment.
new MyStack(app, 'Stack1');
+
+ +

Default

    +
  • The environment of the containing Stage if available, +otherwise create the stack will be environment-agnostic.
    • +
+
+
+

Readonly imageKind

+
imageKind: ImageKind
+

The Image type to create.

+
+
+
+

Optional Readonly permissionsBoundary

+
permissionsBoundary?: PermissionsBoundary
+

Options for applying a permissions boundary to all IAM Roles +and Users created within this Stage

+
+
+

Default

- no permissions boundary is applied
+
+
+
+

Readonly repository

+
repository: IRepository
+

The ECR Repository to push to.

+
+
+
+

Optional Readonly stackName

+
stackName?: string
+

Name to deploy the stack with

+
+
+

Default

- Derived from construct path.
+
+
+
+

Optional Readonly suppressTemplateIndentation

+
suppressTemplateIndentation?: boolean
+

Enable this flag to suppress indentation in generated +CloudFormation templates.

+

If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation +context key will be used. If that is not specified, then the +default value false will be used.

+
+
+

Default

    +
  • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
    • +
+
+
+

Optional Readonly synthesizer

+
synthesizer?: IStackSynthesizer
+

Synthesis method to use while deploying this stack

+

The Stack Synthesizer controls aspects of synthesis and deployment, +like how assets are referenced and what IAM roles to use. For more +information, see the README of the main CDK package.

+

If not specified, the defaultStackSynthesizer from App will be used. +If that is not specified, DefaultStackSynthesizer is used if +@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major +version is v2. In CDK v1 LegacyStackSynthesizer is the default if no +other synthesizer is specified.

+
+
+

Default

    +
  • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
    • +
+
+
+

Optional Readonly tags

+
tags?: {
    [key: string]: string;
}
+

Stack tags that will be applied to all the taggable resources and the stack itself.

+
+
+

Type declaration

+
    +
  • +
    [key: string]: string
+
+

Default

{}
+
+
+
+

Optional Readonly terminationProtection

+
terminationProtection?: boolean
+

Whether to enable termination protection for this stack.

+
+
+

Default

false
+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/interfaces/DemoPipelineProps.html b/interfaces/DemoPipelineProps.html new file mode 100644 index 0000000..4622e3d --- /dev/null +++ b/interfaces/DemoPipelineProps.html @@ -0,0 +1,310 @@ +DemoPipelineProps | aws4embeddedlinux-cdk-lib
+
+ +
+
+
+
+ +

Interface DemoPipelineProps

+
+

Properties to allow customizing the build.

+
+
+
+

Hierarchy

+
    +
  • StackProps +
      +
    • DemoPipelineProps
+
+
+
+ +
+
+

Properties

+
analyticsReporting? +crossRegionReferences? +description? +env? +imageRepo +imageTag? +layerRepoName? +permissionsBoundary? +projectKind? +stackName? +suppressTemplateIndentation? +synthesizer? +tags? +terminationProtection? +vpc +
+
+

Properties

+
+

Optional Readonly analyticsReporting

+
analyticsReporting?: boolean
+

Include runtime versioning information in this Stack

+
+
+

Default

analyticsReporting setting of containing App, or value of +'aws:cdk:version-reporting' context key

+
+
+

Optional Readonly crossRegionReferences

+
crossRegionReferences?: boolean
+

Enable this flag to allow native cross region stack references.

+

Enabling this will create a CloudFormation custom resource +in both the producing stack and consuming stack in order to perform the export/import

+

This feature is currently experimental

+
+
+

Default

false
+
+
+
+

Optional Readonly description

+
description?: string
+

A description of the stack.

+
+
+

Default

- No description.
+
+
+
+

Optional Readonly env

+
env?: Environment
+

The AWS environment (account/region) where this stack will be deployed.

+

Set the region/account fields of env to either a concrete value to +select the indicated environment (recommended for production stacks), or to +the values of environment variables +CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment +depend on the AWS credentials/configuration that the CDK CLI is executed +under (recommended for development stacks).

+

If the Stack is instantiated inside a Stage, any undefined +region/account fields from env will default to the same field on the +encompassing Stage, if configured there.

+

If either region or account are not set nor inherited from Stage, the +Stack will be considered "environment-agnostic"". Environment-agnostic +stacks can be deployed to any environment but may not be able to take +advantage of all features of the CDK. For example, they will not be able to +use environmental context lookups such as ec2.Vpc.fromLookup and will not +automatically translate Service Principals to the right format based on the +environment's AWS partition, and other such enhancements.

+
+
+

Example

// Use a concrete account and region to deploy this stack to:
// `.account` and `.region` will simply return these values.
new Stack(app, 'Stack1', {
  env: {
    account: '123456789012',
    region: 'us-east-1'
  },
});

// Use the CLI's current credentials to determine the target environment:
// `.account` and `.region` will reflect the account+region the CLI
// is configured to use (based on the user CLI credentials)
new Stack(app, 'Stack2', {
  env: {
    account: process.env.CDK_DEFAULT_ACCOUNT,
    region: process.env.CDK_DEFAULT_REGION
  },
});

// Define multiple stacks stage associated with an environment
const myStage = new Stage(app, 'MyStage', {
  env: {
    account: '123456789012',
    region: 'us-east-1'
  }
});

// both of these stacks will use the stage's account/region:
// `.account` and `.region` will resolve to the concrete values as above
new MyStack(myStage, 'Stack1');
new YourStack(myStage, 'Stack2');

// Define an environment-agnostic stack:
// `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
// which will only resolve to actual values by CloudFormation during deployment.
new MyStack(app, 'Stack1');
+
+ +

Default

    +
  • The environment of the containing Stage if available, +otherwise create the stack will be environment-agnostic.
    • +
+
+
+

Readonly imageRepo

+
imageRepo: IRepository
+

ECR Repository where the Build Host Image resides.

+
+
+
+

Optional Readonly imageTag

+
imageTag?: string
+

Tag for the Build Host Image

+
+
+
+

Optional Readonly layerRepoName

+
layerRepoName?: string
+

A name for the layer-repo that is created. Default is 'layer-repo'

+
+
+
+

Optional Readonly permissionsBoundary

+
permissionsBoundary?: PermissionsBoundary
+

Options for applying a permissions boundary to all IAM Roles +and Users created within this Stage

+
+
+

Default

- no permissions boundary is applied
+
+
+
+

Optional Readonly projectKind

+
projectKind?: ProjectKind
+

The type of project being built.

+
+
+
+

Optional Readonly stackName

+
stackName?: string
+

Name to deploy the stack with

+
+
+

Default

- Derived from construct path.
+
+
+
+

Optional Readonly suppressTemplateIndentation

+
suppressTemplateIndentation?: boolean
+

Enable this flag to suppress indentation in generated +CloudFormation templates.

+

If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation +context key will be used. If that is not specified, then the +default value false will be used.

+
+
+

Default

    +
  • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
    • +
+
+
+

Optional Readonly synthesizer

+
synthesizer?: IStackSynthesizer
+

Synthesis method to use while deploying this stack

+

The Stack Synthesizer controls aspects of synthesis and deployment, +like how assets are referenced and what IAM roles to use. For more +information, see the README of the main CDK package.

+

If not specified, the defaultStackSynthesizer from App will be used. +If that is not specified, DefaultStackSynthesizer is used if +@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major +version is v2. In CDK v1 LegacyStackSynthesizer is the default if no +other synthesizer is specified.

+
+
+

Default

    +
  • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
    • +
+
+
+

Optional Readonly tags

+
tags?: {
    [key: string]: string;
}
+

Stack tags that will be applied to all the taggable resources and the stack itself.

+
+
+

Type declaration

+
    +
  • +
    [key: string]: string
+
+

Default

{}
+
+
+
+

Optional Readonly terminationProtection

+
terminationProtection?: boolean
+

Whether to enable termination protection for this stack.

+
+
+

Default

false
+
+
+
+

Readonly vpc

+
vpc: IVpc
+

VPC where the networking setup resides.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html new file mode 100644 index 0000000..7b208f8 --- /dev/null +++ b/interfaces/SourceRepoProps.html @@ -0,0 +1,276 @@ +SourceRepoProps | aws4embeddedlinux-cdk-lib
+
+ +
+
+
+
+ +

Interface SourceRepoProps

+
+

Hierarchy

+
    +
  • StackProps +
      +
    • SourceRepoProps
+
+
+
+ +
+
+

Properties

+
analyticsReporting? +crossRegionReferences? +description? +env? +kind +permissionsBoundary? +repoName +stackName? +suppressTemplateIndentation? +synthesizer? +tags? +terminationProtection? +
+
+

Properties

+
+

Optional Readonly analyticsReporting

+
analyticsReporting?: boolean
+

Include runtime versioning information in this Stack

+
+
+

Default

analyticsReporting setting of containing App, or value of +'aws:cdk:version-reporting' context key

+
+
+

Optional Readonly crossRegionReferences

+
crossRegionReferences?: boolean
+

Enable this flag to allow native cross region stack references.

+

Enabling this will create a CloudFormation custom resource +in both the producing stack and consuming stack in order to perform the export/import

+

This feature is currently experimental

+
+
+

Default

false
+
+
+
+

Optional Readonly description

+
description?: string
+

A description of the stack.

+
+
+

Default

- No description.
+
+
+
+

Optional Readonly env

+
env?: Environment
+

The AWS environment (account/region) where this stack will be deployed.

+

Set the region/account fields of env to either a concrete value to +select the indicated environment (recommended for production stacks), or to +the values of environment variables +CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment +depend on the AWS credentials/configuration that the CDK CLI is executed +under (recommended for development stacks).

+

If the Stack is instantiated inside a Stage, any undefined +region/account fields from env will default to the same field on the +encompassing Stage, if configured there.

+

If either region or account are not set nor inherited from Stage, the +Stack will be considered "environment-agnostic"". Environment-agnostic +stacks can be deployed to any environment but may not be able to take +advantage of all features of the CDK. For example, they will not be able to +use environmental context lookups such as ec2.Vpc.fromLookup and will not +automatically translate Service Principals to the right format based on the +environment's AWS partition, and other such enhancements.

+
+
+

Example

// Use a concrete account and region to deploy this stack to:
// `.account` and `.region` will simply return these values.
new Stack(app, 'Stack1', {
  env: {
    account: '123456789012',
    region: 'us-east-1'
  },
});

// Use the CLI's current credentials to determine the target environment:
// `.account` and `.region` will reflect the account+region the CLI
// is configured to use (based on the user CLI credentials)
new Stack(app, 'Stack2', {
  env: {
    account: process.env.CDK_DEFAULT_ACCOUNT,
    region: process.env.CDK_DEFAULT_REGION
  },
});

// Define multiple stacks stage associated with an environment
const myStage = new Stage(app, 'MyStage', {
  env: {
    account: '123456789012',
    region: 'us-east-1'
  }
});

// both of these stacks will use the stage's account/region:
// `.account` and `.region` will resolve to the concrete values as above
new MyStack(myStage, 'Stack1');
new YourStack(myStage, 'Stack2');

// Define an environment-agnostic stack:
// `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
// which will only resolve to actual values by CloudFormation during deployment.
new MyStack(app, 'Stack1');
+
+ +

Default

    +
  • The environment of the containing Stage if available, +otherwise create the stack will be environment-agnostic.
    • +
+
+
+

Readonly kind

+
kind: ProjectKind
+

The type of project to seed this repository with.

+
+
+
+

Optional Readonly permissionsBoundary

+
permissionsBoundary?: PermissionsBoundary
+

Options for applying a permissions boundary to all IAM Roles +and Users created within this Stage

+
+
+

Default

- no permissions boundary is applied
+
+
+
+

Readonly repoName

+
repoName: string
+

The name of the CodeCommit Repository created.

+
+
+
+

Optional Readonly stackName

+
stackName?: string
+

Name to deploy the stack with

+
+
+

Default

- Derived from construct path.
+
+
+
+

Optional Readonly suppressTemplateIndentation

+
suppressTemplateIndentation?: boolean
+

Enable this flag to suppress indentation in generated +CloudFormation templates.

+

If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation +context key will be used. If that is not specified, then the +default value false will be used.

+
+
+

Default

    +
  • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
    • +
+
+
+

Optional Readonly synthesizer

+
synthesizer?: IStackSynthesizer
+

Synthesis method to use while deploying this stack

+

The Stack Synthesizer controls aspects of synthesis and deployment, +like how assets are referenced and what IAM roles to use. For more +information, see the README of the main CDK package.

+

If not specified, the defaultStackSynthesizer from App will be used. +If that is not specified, DefaultStackSynthesizer is used if +@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major +version is v2. In CDK v1 LegacyStackSynthesizer is the default if no +other synthesizer is specified.

+
+
+

Default

    +
  • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
    • +
+
+
+

Optional Readonly tags

+
tags?: {
    [key: string]: string;
}
+

Stack tags that will be applied to all the taggable resources and the stack itself.

+
+
+

Type declaration

+
    +
  • +
    [key: string]: string
+
+

Default

{}
+
+
+
+

Optional Readonly terminationProtection

+
terminationProtection?: boolean
+

Whether to enable termination protection for this stack.

+
+
+

Default

false
+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file From 9c5dd87f851116c6d808574249d42f8c35f70b3c Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Thu, 16 Nov 2023 10:40:01 +0000 Subject: [PATCH 03/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@379bc8efcd21e9eac966a95a81?= =?UTF-8?q?bbae421bec13c9=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/BuildImageDataStack.html | 8 ++++---- classes/BuildImagePipelineStack.html | 4 ++-- classes/BuildImageRepoStack.html | 6 +++--- classes/DemoPipelineStack.html | 16 ++++++++-------- classes/PipelineNetworkStack.html | 6 +++--- classes/SourceRepo.html | 6 +++--- enums/ImageKind.html | 8 ++++---- enums/ProjectKind.html | 12 ++++++------ interfaces/BuildImageDataProps.html | 4 ++-- interfaces/BuildImagePipelineProps.html | 8 ++++---- interfaces/DemoPipelineProps.html | 12 ++++++------ interfaces/SourceRepoProps.html | 6 +++--- 12 files changed, 48 insertions(+), 48 deletions(-) diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html index caa8b1a..db1c6d0 100644 --- a/classes/BuildImageDataStack.html +++ b/classes/BuildImageDataStack.html @@ -26,7 +26,7 @@

Hierarchy

  • BuildImageDataStack
+
  • Defined in lib/build-image-data.ts:22
    • @@ -116,7 +116,7 @@
    props: Returns BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:26

    • Properties

    @@ -179,7 +179,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:24

    • Readonly environment

    environment: string
    @@ -720,7 +720,7 @@
    bucketName: Returns IBucket
    +
  • Defined in lib/build-image-data.ts:38

    • exportStringListValue

      diff --git a/classes/BuildImagePipelineStack.html b/classes/BuildImagePipelineStack.html index 8eb5242..4ef626d 100644 --- a/classes/BuildImagePipelineStack.html +++ b/classes/BuildImagePipelineStack.html @@ -27,7 +27,7 @@

      Hierarchy

      • BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:42
    • @@ -115,7 +115,7 @@
    props: Returns BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:43

    • Properties

    diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html index 8795bc1..05771f7 100644 --- a/classes/BuildImageRepoStack.html +++ b/classes/BuildImageRepoStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:8
    • @@ -115,7 +115,7 @@
    Optional Returns BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:12

    • Properties

    @@ -239,7 +239,7 @@

    Readonly

    +
  • Defined in lib/build-image-repo.ts:10

    • Readonly synthesizer

    synthesizer: IStackSynthesizer
    diff --git a/classes/DemoPipelineStack.html b/classes/DemoPipelineStack.html index de57441..f9cc2fa 100644 --- a/classes/DemoPipelineStack.html +++ b/classes/DemoPipelineStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • DemoPipelineStack
    +
  • Defined in lib/demo-pipeline.ts:56
    • @@ -120,7 +120,7 @@
    props: Returns DemoPipelineStack
    +
  • Defined in lib/demo-pipeline.ts:57

    • Properties

    @@ -585,7 +585,7 @@

    Private

  • Returns PolicyStatement

    • +
  • Defined in lib/demo-pipeline.ts:394

    • Private addAMIEBSBackupPolicy

      @@ -598,7 +598,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/demo-pipeline.ts:381

    • Private addAMIEC2EBSBackupPolicy

      @@ -611,7 +611,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/demo-pipeline.ts:401

    • Private addAMIS3BackupPolicy

      @@ -624,7 +624,7 @@

      Parameters

      artifactBucketArn: string

    Returns PolicyStatement

    +
  • Defined in lib/demo-pipeline.ts:369

    • addDependency

    +
  • Defined in lib/demo-pipeline.ts:336

    • addMetadata

    +
  • Defined in lib/demo-pipeline.ts:354

    • Protected allocateLogicalId

      diff --git a/classes/PipelineNetworkStack.html b/classes/PipelineNetworkStack.html index 481a8cd..372cb9b 100644 --- a/classes/PipelineNetworkStack.html +++ b/classes/PipelineNetworkStack.html @@ -26,7 +26,7 @@

      Hierarchy

      • PipelineNetworkStack
    +
  • Defined in lib/network.ts:9
    • @@ -113,7 +113,7 @@
    Optional Returns PipelineNetworkStack
    +
  • Defined in lib/network.ts:13

    • Properties

    @@ -284,7 +284,7 @@

    Readonly

    +
  • Defined in lib/network.ts:11

    • Accessors

    diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html index 43590c4..f67de8d 100644 --- a/classes/SourceRepo.html +++ b/classes/SourceRepo.html @@ -26,7 +26,7 @@

    Hierarchy

    • SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:33
    • @@ -65,7 +65,7 @@
    props: Returns SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:37

    • Properties

    @@ -84,7 +84,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:35

    • Methods

    diff --git a/enums/ImageKind.html b/enums/ImageKind.html index 164dcbe..6c1f65d 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -20,7 +20,7 @@

    Enumeration ImageKind

    +
  • Defined in lib/build-image-pipeline.ts:17
    • @@ -41,7 +41,7 @@

    Debian11

    +
  • Defined in lib/build-image-pipeline.ts:23

    • Fedora37

    Fedora37: "fedora_37"
    @@ -49,7 +49,7 @@

    Fedora37

    +
  • Defined in lib/build-image-pipeline.ts:21

    • Ubuntu22_04

    Ubuntu22_04: "ubuntu_22_04"
    @@ -57,7 +57,7 @@

    Ubuntu22_04

    +
  • Defined in lib/build-image-pipeline.ts:19
    • diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html index 14bd16b..1712255 100644 --- a/enums/ProjectKind.html +++ b/enums/ProjectKind.html @@ -20,7 +20,7 @@

    Enumeration ProjectKind

    +
  • Defined in lib/constructs/source-repo.ts:10
    • @@ -43,7 +43,7 @@

    Kas

    +
  • Defined in lib/constructs/source-repo.ts:18

    • MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"
    @@ -51,7 +51,7 @@

    MetaAwsDemo

    +
  • Defined in lib/constructs/source-repo.ts:14

    • Poky

    Poky: "poky"
    @@ -59,7 +59,7 @@

    Poky

    +
  • Defined in lib/constructs/source-repo.ts:12

    • PokyAmi

    PokyAmi: "poky-ami"
    @@ -67,7 +67,7 @@

    PokyAmi

    +
  • Defined in lib/constructs/source-repo.ts:16

    • Renesas

    Renesas: "renesas"
    @@ -75,7 +75,7 @@

    Renesas

    +
  • Defined in lib/constructs/source-repo.ts:20
    • diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html index 8c6a212..7b0fc38 100644 --- a/interfaces/BuildImageDataProps.html +++ b/interfaces/BuildImageDataProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataProps
    +
  • Defined in lib/build-image-data.ts:14
    • @@ -67,7 +67,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:16

    • Optional Readonly crossRegionReferences

    crossRegionReferences?: boolean
    diff --git a/interfaces/BuildImagePipelineProps.html b/interfaces/BuildImagePipelineProps.html index 65d8eec..c1f3bfd 100644 --- a/interfaces/BuildImagePipelineProps.html +++ b/interfaces/BuildImagePipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImagePipelineProps
    +
  • Defined in lib/build-image-pipeline.ts:29
    • @@ -84,7 +84,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:33

    • Optional Readonly description

    description?: string
    @@ -137,7 +137,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:31

    • Optional Readonly permissionsBoundary

    permissionsBoundary?: PermissionsBoundary
    @@ -158,7 +158,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:35

    • Optional Readonly stackName

    stackName?: string
    diff --git a/interfaces/DemoPipelineProps.html b/interfaces/DemoPipelineProps.html index 4622e3d..8a8195c 100644 --- a/interfaces/DemoPipelineProps.html +++ b/interfaces/DemoPipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • DemoPipelineProps
    +
  • Defined in lib/demo-pipeline.ts:40
    • @@ -131,7 +131,7 @@

    Readonly

    +
  • Defined in lib/demo-pipeline.ts:42

    • Optional Readonly imageTag

    imageTag?: string
    @@ -139,7 +139,7 @@

    Optional

    +
  • Defined in lib/demo-pipeline.ts:44

    • Optional Readonly layerRepoName

    layerRepoName?: string
    @@ -147,7 +147,7 @@

    Optional

    +
  • Defined in lib/demo-pipeline.ts:50

    • Optional Readonly permissionsBoundary

    permissionsBoundary?: PermissionsBoundary
    @@ -168,7 +168,7 @@

    Optional

    +
  • Defined in lib/demo-pipeline.ts:48

    • Optional Readonly stackName

    stackName?: string
    @@ -255,7 +255,7 @@

    Readonly

    +
  • Defined in lib/demo-pipeline.ts:46
    • diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html index 7b208f8..cdadd37 100644 --- a/interfaces/SourceRepoProps.html +++ b/interfaces/SourceRepoProps.html @@ -22,7 +22,7 @@

    Hierarchy

    • SourceRepoProps
    +
  • Defined in lib/constructs/source-repo.ts:23
    • @@ -124,7 +124,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:27

    • Optional Readonly permissionsBoundary

    permissionsBoundary?: PermissionsBoundary
    @@ -145,7 +145,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:25

    • Optional Readonly stackName

    stackName?: string
    From 1fe26474691890daaa42e731e0cfd8ccb6f3967d Mon Sep 17 00:00:00 2001 From: nateglims Date: Mon, 20 Nov 2023 18:36:36 +0000 Subject: [PATCH 04/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@9a2ff581d953dd80238d1299d6?= =?UTF-8?q?4f5bdd06798d0c=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- assets/search.js | 2 +- classes/BuildImageDataStack.html | 8 ++++---- classes/BuildImagePipelineStack.html | 4 ++-- classes/BuildImageRepoStack.html | 6 +++--- classes/DemoPipelineStack.html | 16 ++++++++-------- classes/PipelineNetworkStack.html | 6 +++--- classes/SourceRepo.html | 6 +++--- enums/ImageKind.html | 8 ++++---- enums/ProjectKind.html | 22 ++++++++++++++++------ interfaces/BuildImageDataProps.html | 4 ++-- interfaces/BuildImagePipelineProps.html | 8 ++++---- interfaces/DemoPipelineProps.html | 12 ++++++------ interfaces/SourceRepoProps.html | 6 +++--- 13 files changed, 59 insertions(+), 49 deletions(-) diff --git a/assets/search.js b/assets/search.js index 14ad00d..03a63a6 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"rows\":[{\"kind\":128,\"name\":\"PipelineNetworkStack\",\"url\":\"classes/PipelineNetworkStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/PipelineNetworkStack.html#constructor\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"classes/PipelineNetworkStack.html#vpc\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":256,\"name\":\"BuildImageDataProps\",\"url\":\"interfaces/BuildImageDataProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"bucketName\",\"url\":\"interfaces/BuildImageDataProps.html#bucketName\",\"classes\":\"\",\"parent\":\"BuildImageDataProps\"},{\"kind\":128,\"name\":\"BuildImageDataStack\",\"url\":\"classes/BuildImageDataStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageDataStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":1024,\"name\":\"bucket\",\"url\":\"classes/BuildImageDataStack.html#bucket\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":2048,\"name\":\"createDeploymentBucket\",\"url\":\"classes/BuildImageDataStack.html#createDeploymentBucket\",\"classes\":\"tsd-is-private\",\"parent\":\"BuildImageDataStack\"},{\"kind\":128,\"name\":\"BuildImageRepoStack\",\"url\":\"classes/BuildImageRepoStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageRepoStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"classes/BuildImageRepoStack.html#repository\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":8,\"name\":\"ImageKind\",\"url\":\"enums/ImageKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Ubuntu22_04\",\"url\":\"enums/ImageKind.html#Ubuntu22_04\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":16,\"name\":\"Fedora37\",\"url\":\"enums/ImageKind.html#Fedora37\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":16,\"name\":\"Debian11\",\"url\":\"enums/ImageKind.html#Debian11\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":256,\"name\":\"BuildImagePipelineProps\",\"url\":\"interfaces/BuildImagePipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageKind\",\"url\":\"interfaces/BuildImagePipelineProps.html#imageKind\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"dataBucket\",\"url\":\"interfaces/BuildImagePipelineProps.html#dataBucket\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"interfaces/BuildImagePipelineProps.html#repository\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":128,\"name\":\"BuildImagePipelineStack\",\"url\":\"classes/BuildImagePipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImagePipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImagePipelineStack\"},{\"kind\":256,\"name\":\"DemoPipelineProps\",\"url\":\"interfaces/DemoPipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageRepo\",\"url\":\"interfaces/DemoPipelineProps.html#imageRepo\",\"classes\":\"\",\"parent\":\"DemoPipelineProps\"},{\"kind\":1024,\"name\":\"imageTag\",\"url\":\"interfaces/DemoPipelineProps.html#imageTag\",\"classes\":\"\",\"parent\":\"DemoPipelineProps\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"interfaces/DemoPipelineProps.html#vpc\",\"classes\":\"\",\"parent\":\"DemoPipelineProps\"},{\"kind\":1024,\"name\":\"projectKind\",\"url\":\"interfaces/DemoPipelineProps.html#projectKind\",\"classes\":\"\",\"parent\":\"DemoPipelineProps\"},{\"kind\":1024,\"name\":\"layerRepoName\",\"url\":\"interfaces/DemoPipelineProps.html#layerRepoName\",\"classes\":\"\",\"parent\":\"DemoPipelineProps\"},{\"kind\":128,\"name\":\"DemoPipelineStack\",\"url\":\"classes/DemoPipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/DemoPipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addFileSystem\",\"url\":\"classes/DemoPipelineStack.html#addFileSystem\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addVMExportPolicy\",\"url\":\"classes/DemoPipelineStack.html#addVMExportPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIS3BackupPolicy\",\"url\":\"classes/DemoPipelineStack.html#addAMIS3BackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEBSBackupPolicy\",\"url\":\"classes/DemoPipelineStack.html#addAMIEBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIBackupPolicy\",\"url\":\"classes/DemoPipelineStack.html#addAMIBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEC2EBSBackupPolicy\",\"url\":\"classes/DemoPipelineStack.html#addAMIEC2EBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":8,\"name\":\"ProjectKind\",\"url\":\"enums/ProjectKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Poky\",\"url\":\"enums/ProjectKind.html#Poky\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"MetaAwsDemo\",\"url\":\"enums/ProjectKind.html#MetaAwsDemo\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"PokyAmi\",\"url\":\"enums/ProjectKind.html#PokyAmi\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Kas\",\"url\":\"enums/ProjectKind.html#Kas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Renesas\",\"url\":\"enums/ProjectKind.html#Renesas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":256,\"name\":\"SourceRepoProps\",\"url\":\"interfaces/SourceRepoProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"repoName\",\"url\":\"interfaces/SourceRepoProps.html#repoName\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":1024,\"name\":\"kind\",\"url\":\"interfaces/SourceRepoProps.html#kind\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":128,\"name\":\"SourceRepo\",\"url\":\"classes/SourceRepo.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/SourceRepo.html#constructor\",\"classes\":\"\",\"parent\":\"SourceRepo\"},{\"kind\":1024,\"name\":\"repo\",\"url\":\"classes/SourceRepo.html#repo\",\"classes\":\"\",\"parent\":\"SourceRepo\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,34.864]],[\"comment/0\",[]],[\"name/1\",[1,20.2]],[\"comment/1\",[]],[\"name/2\",[2,29.755]],[\"comment/2\",[]],[\"name/3\",[3,34.864]],[\"comment/3\",[]],[\"name/4\",[4,34.864]],[\"comment/4\",[]],[\"name/5\",[5,34.864]],[\"comment/5\",[]],[\"name/6\",[1,20.2]],[\"comment/6\",[]],[\"name/7\",[6,34.864]],[\"comment/7\",[]],[\"name/8\",[7,34.864]],[\"comment/8\",[]],[\"name/9\",[8,34.864]],[\"comment/9\",[]],[\"name/10\",[1,20.2]],[\"comment/10\",[]],[\"name/11\",[9,29.755]],[\"comment/11\",[]],[\"name/12\",[10,29.755]],[\"comment/12\",[]],[\"name/13\",[11,34.864]],[\"comment/13\",[]],[\"name/14\",[12,34.864]],[\"comment/14\",[]],[\"name/15\",[13,34.864]],[\"comment/15\",[]],[\"name/16\",[14,34.864]],[\"comment/16\",[]],[\"name/17\",[10,29.755]],[\"comment/17\",[]],[\"name/18\",[15,34.864]],[\"comment/18\",[]],[\"name/19\",[9,29.755]],[\"comment/19\",[]],[\"name/20\",[16,34.864]],[\"comment/20\",[]],[\"name/21\",[1,20.2]],[\"comment/21\",[]],[\"name/22\",[17,34.864]],[\"comment/22\",[]],[\"name/23\",[18,34.864]],[\"comment/23\",[]],[\"name/24\",[19,34.864]],[\"comment/24\",[]],[\"name/25\",[2,29.755]],[\"comment/25\",[]],[\"name/26\",[20,29.755]],[\"comment/26\",[]],[\"name/27\",[21,34.864]],[\"comment/27\",[]],[\"name/28\",[22,34.864]],[\"comment/28\",[]],[\"name/29\",[1,20.2]],[\"comment/29\",[]],[\"name/30\",[23,34.864]],[\"comment/30\",[]],[\"name/31\",[24,34.864]],[\"comment/31\",[]],[\"name/32\",[25,34.864]],[\"comment/32\",[]],[\"name/33\",[26,34.864]],[\"comment/33\",[]],[\"name/34\",[27,34.864]],[\"comment/34\",[]],[\"name/35\",[28,34.864]],[\"comment/35\",[]],[\"name/36\",[20,29.755]],[\"comment/36\",[]],[\"name/37\",[29,34.864]],[\"comment/37\",[]],[\"name/38\",[30,34.864]],[\"comment/38\",[]],[\"name/39\",[31,34.864]],[\"comment/39\",[]],[\"name/40\",[32,34.864]],[\"comment/40\",[]],[\"name/41\",[33,34.864]],[\"comment/41\",[]],[\"name/42\",[34,34.864]],[\"comment/42\",[]],[\"name/43\",[35,34.864]],[\"comment/43\",[]],[\"name/44\",[36,34.864]],[\"comment/44\",[]],[\"name/45\",[37,34.864]],[\"comment/45\",[]],[\"name/46\",[1,20.2]],[\"comment/46\",[]],[\"name/47\",[38,34.864]],[\"comment/47\",[]]],\"invertedIndex\":[[\"addamibackuppolicy\",{\"_index\":27,\"name\":{\"34\":{}},\"comment\":{}}],[\"addamiebsbackuppolicy\",{\"_index\":26,\"name\":{\"33\":{}},\"comment\":{}}],[\"addamiec2ebsbackuppolicy\",{\"_index\":28,\"name\":{\"35\":{}},\"comment\":{}}],[\"addamis3backuppolicy\",{\"_index\":25,\"name\":{\"32\":{}},\"comment\":{}}],[\"addfilesystem\",{\"_index\":23,\"name\":{\"30\":{}},\"comment\":{}}],[\"addvmexportpolicy\",{\"_index\":24,\"name\":{\"31\":{}},\"comment\":{}}],[\"bucket\",{\"_index\":6,\"name\":{\"7\":{}},\"comment\":{}}],[\"bucketname\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"buildimagedataprops\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"buildimagedatastack\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"buildimagepipelineprops\",{\"_index\":14,\"name\":{\"16\":{}},\"comment\":{}}],[\"buildimagepipelinestack\",{\"_index\":16,\"name\":{\"20\":{}},\"comment\":{}}],[\"buildimagerepostack\",{\"_index\":8,\"name\":{\"9\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{},\"6\":{},\"10\":{},\"21\":{},\"29\":{},\"46\":{}},\"comment\":{}}],[\"createdeploymentbucket\",{\"_index\":7,\"name\":{\"8\":{}},\"comment\":{}}],[\"databucket\",{\"_index\":15,\"name\":{\"18\":{}},\"comment\":{}}],[\"debian11\",{\"_index\":13,\"name\":{\"15\":{}},\"comment\":{}}],[\"demopipelineprops\",{\"_index\":17,\"name\":{\"22\":{}},\"comment\":{}}],[\"demopipelinestack\",{\"_index\":22,\"name\":{\"28\":{}},\"comment\":{}}],[\"fedora37\",{\"_index\":12,\"name\":{\"14\":{}},\"comment\":{}}],[\"imagekind\",{\"_index\":10,\"name\":{\"12\":{},\"17\":{}},\"comment\":{}}],[\"imagerepo\",{\"_index\":18,\"name\":{\"23\":{}},\"comment\":{}}],[\"imagetag\",{\"_index\":19,\"name\":{\"24\":{}},\"comment\":{}}],[\"kas\",{\"_index\":32,\"name\":{\"40\":{}},\"comment\":{}}],[\"kind\",{\"_index\":36,\"name\":{\"44\":{}},\"comment\":{}}],[\"layerreponame\",{\"_index\":21,\"name\":{\"27\":{}},\"comment\":{}}],[\"metaawsdemo\",{\"_index\":30,\"name\":{\"38\":{}},\"comment\":{}}],[\"pipelinenetworkstack\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"poky\",{\"_index\":29,\"name\":{\"37\":{}},\"comment\":{}}],[\"pokyami\",{\"_index\":31,\"name\":{\"39\":{}},\"comment\":{}}],[\"projectkind\",{\"_index\":20,\"name\":{\"26\":{},\"36\":{}},\"comment\":{}}],[\"renesas\",{\"_index\":33,\"name\":{\"41\":{}},\"comment\":{}}],[\"repo\",{\"_index\":38,\"name\":{\"47\":{}},\"comment\":{}}],[\"reponame\",{\"_index\":35,\"name\":{\"43\":{}},\"comment\":{}}],[\"repository\",{\"_index\":9,\"name\":{\"11\":{},\"19\":{}},\"comment\":{}}],[\"sourcerepo\",{\"_index\":37,\"name\":{\"45\":{}},\"comment\":{}}],[\"sourcerepoprops\",{\"_index\":34,\"name\":{\"42\":{}},\"comment\":{}}],[\"ubuntu22_04\",{\"_index\":11,\"name\":{\"13\":{}},\"comment\":{}}],[\"vpc\",{\"_index\":2,\"name\":{\"2\":{},\"25\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = JSON.parse("{\"rows\":[{\"kind\":128,\"name\":\"PipelineNetworkStack\",\"url\":\"classes/PipelineNetworkStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/PipelineNetworkStack.html#constructor\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"classes/PipelineNetworkStack.html#vpc\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":256,\"name\":\"BuildImageDataProps\",\"url\":\"interfaces/BuildImageDataProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"bucketName\",\"url\":\"interfaces/BuildImageDataProps.html#bucketName\",\"classes\":\"\",\"parent\":\"BuildImageDataProps\"},{\"kind\":128,\"name\":\"BuildImageDataStack\",\"url\":\"classes/BuildImageDataStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageDataStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":1024,\"name\":\"bucket\",\"url\":\"classes/BuildImageDataStack.html#bucket\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":2048,\"name\":\"createDeploymentBucket\",\"url\":\"classes/BuildImageDataStack.html#createDeploymentBucket\",\"classes\":\"tsd-is-private\",\"parent\":\"BuildImageDataStack\"},{\"kind\":128,\"name\":\"BuildImageRepoStack\",\"url\":\"classes/BuildImageRepoStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageRepoStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"classes/BuildImageRepoStack.html#repository\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":8,\"name\":\"ImageKind\",\"url\":\"enums/ImageKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Ubuntu22_04\",\"url\":\"enums/ImageKind.html#Ubuntu22_04\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":16,\"name\":\"Fedora37\",\"url\":\"enums/ImageKind.html#Fedora37\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":16,\"name\":\"Debian11\",\"url\":\"enums/ImageKind.html#Debian11\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":256,\"name\":\"BuildImagePipelineProps\",\"url\":\"interfaces/BuildImagePipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageKind\",\"url\":\"interfaces/BuildImagePipelineProps.html#imageKind\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"dataBucket\",\"url\":\"interfaces/BuildImagePipelineProps.html#dataBucket\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"interfaces/BuildImagePipelineProps.html#repository\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":128,\"name\":\"BuildImagePipelineStack\",\"url\":\"classes/BuildImagePipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImagePipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImagePipelineStack\"},{\"kind\":256,\"name\":\"DemoPipelineProps\",\"url\":\"interfaces/DemoPipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageRepo\",\"url\":\"interfaces/DemoPipelineProps.html#imageRepo\",\"classes\":\"\",\"parent\":\"DemoPipelineProps\"},{\"kind\":1024,\"name\":\"imageTag\",\"url\":\"interfaces/DemoPipelineProps.html#imageTag\",\"classes\":\"\",\"parent\":\"DemoPipelineProps\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"interfaces/DemoPipelineProps.html#vpc\",\"classes\":\"\",\"parent\":\"DemoPipelineProps\"},{\"kind\":1024,\"name\":\"projectKind\",\"url\":\"interfaces/DemoPipelineProps.html#projectKind\",\"classes\":\"\",\"parent\":\"DemoPipelineProps\"},{\"kind\":1024,\"name\":\"layerRepoName\",\"url\":\"interfaces/DemoPipelineProps.html#layerRepoName\",\"classes\":\"\",\"parent\":\"DemoPipelineProps\"},{\"kind\":128,\"name\":\"DemoPipelineStack\",\"url\":\"classes/DemoPipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/DemoPipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addFileSystem\",\"url\":\"classes/DemoPipelineStack.html#addFileSystem\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addVMExportPolicy\",\"url\":\"classes/DemoPipelineStack.html#addVMExportPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIS3BackupPolicy\",\"url\":\"classes/DemoPipelineStack.html#addAMIS3BackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEBSBackupPolicy\",\"url\":\"classes/DemoPipelineStack.html#addAMIEBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIBackupPolicy\",\"url\":\"classes/DemoPipelineStack.html#addAMIBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEC2EBSBackupPolicy\",\"url\":\"classes/DemoPipelineStack.html#addAMIEC2EBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":8,\"name\":\"ProjectKind\",\"url\":\"enums/ProjectKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Poky\",\"url\":\"enums/ProjectKind.html#Poky\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"MetaAwsDemo\",\"url\":\"enums/ProjectKind.html#MetaAwsDemo\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"PokyAmi\",\"url\":\"enums/ProjectKind.html#PokyAmi\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Kas\",\"url\":\"enums/ProjectKind.html#Kas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Renesas\",\"url\":\"enums/ProjectKind.html#Renesas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"NxpImx\",\"url\":\"enums/ProjectKind.html#NxpImx\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":256,\"name\":\"SourceRepoProps\",\"url\":\"interfaces/SourceRepoProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"repoName\",\"url\":\"interfaces/SourceRepoProps.html#repoName\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":1024,\"name\":\"kind\",\"url\":\"interfaces/SourceRepoProps.html#kind\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":128,\"name\":\"SourceRepo\",\"url\":\"classes/SourceRepo.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/SourceRepo.html#constructor\",\"classes\":\"\",\"parent\":\"SourceRepo\"},{\"kind\":1024,\"name\":\"repo\",\"url\":\"classes/SourceRepo.html#repo\",\"classes\":\"\",\"parent\":\"SourceRepo\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,35.066]],[\"comment/0\",[]],[\"name/1\",[1,20.402]],[\"comment/1\",[]],[\"name/2\",[2,29.957]],[\"comment/2\",[]],[\"name/3\",[3,35.066]],[\"comment/3\",[]],[\"name/4\",[4,35.066]],[\"comment/4\",[]],[\"name/5\",[5,35.066]],[\"comment/5\",[]],[\"name/6\",[1,20.402]],[\"comment/6\",[]],[\"name/7\",[6,35.066]],[\"comment/7\",[]],[\"name/8\",[7,35.066]],[\"comment/8\",[]],[\"name/9\",[8,35.066]],[\"comment/9\",[]],[\"name/10\",[1,20.402]],[\"comment/10\",[]],[\"name/11\",[9,29.957]],[\"comment/11\",[]],[\"name/12\",[10,29.957]],[\"comment/12\",[]],[\"name/13\",[11,35.066]],[\"comment/13\",[]],[\"name/14\",[12,35.066]],[\"comment/14\",[]],[\"name/15\",[13,35.066]],[\"comment/15\",[]],[\"name/16\",[14,35.066]],[\"comment/16\",[]],[\"name/17\",[10,29.957]],[\"comment/17\",[]],[\"name/18\",[15,35.066]],[\"comment/18\",[]],[\"name/19\",[9,29.957]],[\"comment/19\",[]],[\"name/20\",[16,35.066]],[\"comment/20\",[]],[\"name/21\",[1,20.402]],[\"comment/21\",[]],[\"name/22\",[17,35.066]],[\"comment/22\",[]],[\"name/23\",[18,35.066]],[\"comment/23\",[]],[\"name/24\",[19,35.066]],[\"comment/24\",[]],[\"name/25\",[2,29.957]],[\"comment/25\",[]],[\"name/26\",[20,29.957]],[\"comment/26\",[]],[\"name/27\",[21,35.066]],[\"comment/27\",[]],[\"name/28\",[22,35.066]],[\"comment/28\",[]],[\"name/29\",[1,20.402]],[\"comment/29\",[]],[\"name/30\",[23,35.066]],[\"comment/30\",[]],[\"name/31\",[24,35.066]],[\"comment/31\",[]],[\"name/32\",[25,35.066]],[\"comment/32\",[]],[\"name/33\",[26,35.066]],[\"comment/33\",[]],[\"name/34\",[27,35.066]],[\"comment/34\",[]],[\"name/35\",[28,35.066]],[\"comment/35\",[]],[\"name/36\",[20,29.957]],[\"comment/36\",[]],[\"name/37\",[29,35.066]],[\"comment/37\",[]],[\"name/38\",[30,35.066]],[\"comment/38\",[]],[\"name/39\",[31,35.066]],[\"comment/39\",[]],[\"name/40\",[32,35.066]],[\"comment/40\",[]],[\"name/41\",[33,35.066]],[\"comment/41\",[]],[\"name/42\",[34,35.066]],[\"comment/42\",[]],[\"name/43\",[35,35.066]],[\"comment/43\",[]],[\"name/44\",[36,35.066]],[\"comment/44\",[]],[\"name/45\",[37,35.066]],[\"comment/45\",[]],[\"name/46\",[38,35.066]],[\"comment/46\",[]],[\"name/47\",[1,20.402]],[\"comment/47\",[]],[\"name/48\",[39,35.066]],[\"comment/48\",[]]],\"invertedIndex\":[[\"addamibackuppolicy\",{\"_index\":27,\"name\":{\"34\":{}},\"comment\":{}}],[\"addamiebsbackuppolicy\",{\"_index\":26,\"name\":{\"33\":{}},\"comment\":{}}],[\"addamiec2ebsbackuppolicy\",{\"_index\":28,\"name\":{\"35\":{}},\"comment\":{}}],[\"addamis3backuppolicy\",{\"_index\":25,\"name\":{\"32\":{}},\"comment\":{}}],[\"addfilesystem\",{\"_index\":23,\"name\":{\"30\":{}},\"comment\":{}}],[\"addvmexportpolicy\",{\"_index\":24,\"name\":{\"31\":{}},\"comment\":{}}],[\"bucket\",{\"_index\":6,\"name\":{\"7\":{}},\"comment\":{}}],[\"bucketname\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"buildimagedataprops\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"buildimagedatastack\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"buildimagepipelineprops\",{\"_index\":14,\"name\":{\"16\":{}},\"comment\":{}}],[\"buildimagepipelinestack\",{\"_index\":16,\"name\":{\"20\":{}},\"comment\":{}}],[\"buildimagerepostack\",{\"_index\":8,\"name\":{\"9\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{},\"6\":{},\"10\":{},\"21\":{},\"29\":{},\"47\":{}},\"comment\":{}}],[\"createdeploymentbucket\",{\"_index\":7,\"name\":{\"8\":{}},\"comment\":{}}],[\"databucket\",{\"_index\":15,\"name\":{\"18\":{}},\"comment\":{}}],[\"debian11\",{\"_index\":13,\"name\":{\"15\":{}},\"comment\":{}}],[\"demopipelineprops\",{\"_index\":17,\"name\":{\"22\":{}},\"comment\":{}}],[\"demopipelinestack\",{\"_index\":22,\"name\":{\"28\":{}},\"comment\":{}}],[\"fedora37\",{\"_index\":12,\"name\":{\"14\":{}},\"comment\":{}}],[\"imagekind\",{\"_index\":10,\"name\":{\"12\":{},\"17\":{}},\"comment\":{}}],[\"imagerepo\",{\"_index\":18,\"name\":{\"23\":{}},\"comment\":{}}],[\"imagetag\",{\"_index\":19,\"name\":{\"24\":{}},\"comment\":{}}],[\"kas\",{\"_index\":32,\"name\":{\"40\":{}},\"comment\":{}}],[\"kind\",{\"_index\":37,\"name\":{\"45\":{}},\"comment\":{}}],[\"layerreponame\",{\"_index\":21,\"name\":{\"27\":{}},\"comment\":{}}],[\"metaawsdemo\",{\"_index\":30,\"name\":{\"38\":{}},\"comment\":{}}],[\"nxpimx\",{\"_index\":34,\"name\":{\"42\":{}},\"comment\":{}}],[\"pipelinenetworkstack\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"poky\",{\"_index\":29,\"name\":{\"37\":{}},\"comment\":{}}],[\"pokyami\",{\"_index\":31,\"name\":{\"39\":{}},\"comment\":{}}],[\"projectkind\",{\"_index\":20,\"name\":{\"26\":{},\"36\":{}},\"comment\":{}}],[\"renesas\",{\"_index\":33,\"name\":{\"41\":{}},\"comment\":{}}],[\"repo\",{\"_index\":39,\"name\":{\"48\":{}},\"comment\":{}}],[\"reponame\",{\"_index\":36,\"name\":{\"44\":{}},\"comment\":{}}],[\"repository\",{\"_index\":9,\"name\":{\"11\":{},\"19\":{}},\"comment\":{}}],[\"sourcerepo\",{\"_index\":38,\"name\":{\"46\":{}},\"comment\":{}}],[\"sourcerepoprops\",{\"_index\":35,\"name\":{\"43\":{}},\"comment\":{}}],[\"ubuntu22_04\",{\"_index\":11,\"name\":{\"13\":{}},\"comment\":{}}],[\"vpc\",{\"_index\":2,\"name\":{\"2\":{},\"25\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html index db1c6d0..f9d8384 100644 --- a/classes/BuildImageDataStack.html +++ b/classes/BuildImageDataStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:22
    • @@ -116,7 +116,7 @@
    props: Returns BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:26

    • Properties

    @@ -179,7 +179,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:24

    • Readonly environment

    environment: string
    @@ -720,7 +720,7 @@
    bucketName: Returns IBucket
    +
  • Defined in lib/build-image-data.ts:38

    • exportStringListValue

      diff --git a/classes/BuildImagePipelineStack.html b/classes/BuildImagePipelineStack.html index 4ef626d..9038c08 100644 --- a/classes/BuildImagePipelineStack.html +++ b/classes/BuildImagePipelineStack.html @@ -27,7 +27,7 @@

      Hierarchy

      • BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:42
    • @@ -115,7 +115,7 @@
    props: Returns BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:43

    • Properties

    diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html index 05771f7..88cb41a 100644 --- a/classes/BuildImageRepoStack.html +++ b/classes/BuildImageRepoStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:8
    • @@ -115,7 +115,7 @@
    Optional Returns BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:12

    • Properties

    @@ -239,7 +239,7 @@

    Readonly

    +
  • Defined in lib/build-image-repo.ts:10

    • Readonly synthesizer

    synthesizer: IStackSynthesizer
    diff --git a/classes/DemoPipelineStack.html b/classes/DemoPipelineStack.html index f9cc2fa..8d74444 100644 --- a/classes/DemoPipelineStack.html +++ b/classes/DemoPipelineStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • DemoPipelineStack
    +
  • Defined in lib/demo-pipeline.ts:56
    • @@ -120,7 +120,7 @@
    props: Returns DemoPipelineStack
    +
  • Defined in lib/demo-pipeline.ts:57

    • Properties

    @@ -585,7 +585,7 @@

    Private

  • Returns PolicyStatement

    • +
  • Defined in lib/demo-pipeline.ts:393

    • Private addAMIEBSBackupPolicy

      @@ -598,7 +598,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/demo-pipeline.ts:380

    • Private addAMIEC2EBSBackupPolicy

      @@ -611,7 +611,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/demo-pipeline.ts:400

    • Private addAMIS3BackupPolicy

      @@ -624,7 +624,7 @@

      Parameters

      artifactBucketArn: string

    Returns PolicyStatement

    +
  • Defined in lib/demo-pipeline.ts:368

    • addDependency

      @@ -675,7 +675,7 @@

      Returns string

    +
  • Defined in lib/demo-pipeline.ts:336

    • addMetadata

    +
  • Defined in lib/demo-pipeline.ts:353

    • Protected allocateLogicalId

      diff --git a/classes/PipelineNetworkStack.html b/classes/PipelineNetworkStack.html index 372cb9b..14125a1 100644 --- a/classes/PipelineNetworkStack.html +++ b/classes/PipelineNetworkStack.html @@ -26,7 +26,7 @@

      Hierarchy

      • PipelineNetworkStack
    +
  • Defined in lib/network.ts:9
    • @@ -113,7 +113,7 @@
    Optional Returns PipelineNetworkStack
    +
  • Defined in lib/network.ts:13

    • Properties

    @@ -284,7 +284,7 @@

    Readonly

    +
  • Defined in lib/network.ts:11

    • Accessors

    diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html index f67de8d..d22b57c 100644 --- a/classes/SourceRepo.html +++ b/classes/SourceRepo.html @@ -26,7 +26,7 @@

    Hierarchy

    • SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:35
    • @@ -65,7 +65,7 @@
    props: Returns SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:39

    • Properties

    @@ -84,7 +84,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:37

    • Methods

    diff --git a/enums/ImageKind.html b/enums/ImageKind.html index 6c1f65d..f3f4363 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -20,7 +20,7 @@

    Enumeration ImageKind

    +
  • Defined in lib/build-image-pipeline.ts:17
    • @@ -41,7 +41,7 @@

    Debian11

    +
  • Defined in lib/build-image-pipeline.ts:23

    • Fedora37

    Fedora37: "fedora_37"
    @@ -49,7 +49,7 @@

    Fedora37

    +
  • Defined in lib/build-image-pipeline.ts:21

    • Ubuntu22_04

    Ubuntu22_04: "ubuntu_22_04"
    @@ -57,7 +57,7 @@

    Ubuntu22_04

    +
  • Defined in lib/build-image-pipeline.ts:19
    • diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html index 1712255..bb30098 100644 --- a/enums/ProjectKind.html +++ b/enums/ProjectKind.html @@ -20,7 +20,7 @@

    Enumeration ProjectKind

    +
  • Defined in lib/constructs/source-repo.ts:10
    • @@ -30,6 +30,7 @@
    Kas MetaAwsDemo +NxpImx Poky PokyAmi Renesas @@ -43,7 +44,7 @@

    Kas

    +
  • Defined in lib/constructs/source-repo.ts:18

    • MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"
    @@ -51,7 +52,15 @@

    MetaAwsDemo

    +
  • Defined in lib/constructs/source-repo.ts:14
    • +
    +

    NxpImx

    +
    NxpImx: "nxp-imx"
    +

    Build an IMX image using NXP layers.

    +
    +

    Poky

    Poky: "poky"
    @@ -59,7 +68,7 @@

    Poky

    +
  • Defined in lib/constructs/source-repo.ts:12

    • PokyAmi

    PokyAmi: "poky-ami"
    @@ -67,7 +76,7 @@

    PokyAmi

    +
  • Defined in lib/constructs/source-repo.ts:16

    • Renesas

    Renesas: "renesas"
    @@ -75,7 +84,7 @@

    Renesas

    +
  • Defined in lib/constructs/source-repo.ts:20
    • @@ -97,6 +106,7 @@

    Kas
  • MetaAwsDemo
    • +
  • NxpImx
  • Poky
  • PokyAmi
  • Renesas

    • diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html index 7b0fc38..f5e8592 100644 --- a/interfaces/BuildImageDataProps.html +++ b/interfaces/BuildImageDataProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataProps
    +
  • Defined in lib/build-image-data.ts:14
    • @@ -67,7 +67,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:16

    • Optional Readonly crossRegionReferences

    crossRegionReferences?: boolean
    diff --git a/interfaces/BuildImagePipelineProps.html b/interfaces/BuildImagePipelineProps.html index c1f3bfd..1272225 100644 --- a/interfaces/BuildImagePipelineProps.html +++ b/interfaces/BuildImagePipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImagePipelineProps
    +
  • Defined in lib/build-image-pipeline.ts:29
    • @@ -84,7 +84,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:33

    • Optional Readonly description

    description?: string
    @@ -137,7 +137,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:31

    • Optional Readonly permissionsBoundary

    permissionsBoundary?: PermissionsBoundary
    @@ -158,7 +158,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:35

    • Optional Readonly stackName

    stackName?: string
    diff --git a/interfaces/DemoPipelineProps.html b/interfaces/DemoPipelineProps.html index 8a8195c..0029794 100644 --- a/interfaces/DemoPipelineProps.html +++ b/interfaces/DemoPipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • DemoPipelineProps
    +
  • Defined in lib/demo-pipeline.ts:40
    • @@ -131,7 +131,7 @@

    Readonly

    +
  • Defined in lib/demo-pipeline.ts:42

    • Optional Readonly imageTag

    imageTag?: string
    @@ -139,7 +139,7 @@

    Optional

    +
  • Defined in lib/demo-pipeline.ts:44

    • Optional Readonly layerRepoName

    layerRepoName?: string
    @@ -147,7 +147,7 @@

    Optional

    +
  • Defined in lib/demo-pipeline.ts:50

    • Optional Readonly permissionsBoundary

    permissionsBoundary?: PermissionsBoundary
    @@ -168,7 +168,7 @@

    Optional

    +
  • Defined in lib/demo-pipeline.ts:48

    • Optional Readonly stackName

    stackName?: string
    @@ -255,7 +255,7 @@

    Readonly

    +
  • Defined in lib/demo-pipeline.ts:46
    • diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html index cdadd37..cee58eb 100644 --- a/interfaces/SourceRepoProps.html +++ b/interfaces/SourceRepoProps.html @@ -22,7 +22,7 @@

    Hierarchy

    • SourceRepoProps
    +
  • Defined in lib/constructs/source-repo.ts:25
    • @@ -124,7 +124,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:29

    • Optional Readonly permissionsBoundary

    permissionsBoundary?: PermissionsBoundary
    @@ -145,7 +145,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:27

    • Optional Readonly stackName

    stackName?: string
    From 1f6b550b717d1fe492312b2ece8c0757630b1fe2 Mon Sep 17 00:00:00 2001 From: nateglims Date: Tue, 21 Nov 2023 17:48:37 +0000 Subject: [PATCH 05/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@b49e2ea1a49a9552a578d70d04?= =?UTF-8?q?ff3e78b2a69fc5=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- assets/search.js | 2 +- classes/BuildImageDataStack.html | 12 +- classes/BuildImagePipelineStack.html | 8 +- classes/BuildImageRepoStack.html | 10 +- ...k.html => EmbeddedLinuxPipelineStack.html} | 148 +++++++++--------- classes/PipelineNetworkStack.html | 10 +- classes/SourceRepo.html | 10 +- enums/ImageKind.html | 12 +- enums/ProjectKind.html | 18 +-- index.html | 8 +- interfaces/BuildImageDataProps.html | 8 +- interfaces/BuildImagePipelineProps.html | 12 +- ...s.html => EmbeddedLinuxPipelineProps.html} | 54 +++---- interfaces/SourceRepoProps.html | 10 +- 14 files changed, 161 insertions(+), 161 deletions(-) rename classes/{DemoPipelineStack.html => EmbeddedLinuxPipelineStack.html} (87%) rename interfaces/{DemoPipelineProps.html => EmbeddedLinuxPipelineProps.html} (86%) diff --git a/assets/search.js b/assets/search.js index 03a63a6..c0d2729 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"rows\":[{\"kind\":128,\"name\":\"PipelineNetworkStack\",\"url\":\"classes/PipelineNetworkStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/PipelineNetworkStack.html#constructor\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"classes/PipelineNetworkStack.html#vpc\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":256,\"name\":\"BuildImageDataProps\",\"url\":\"interfaces/BuildImageDataProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"bucketName\",\"url\":\"interfaces/BuildImageDataProps.html#bucketName\",\"classes\":\"\",\"parent\":\"BuildImageDataProps\"},{\"kind\":128,\"name\":\"BuildImageDataStack\",\"url\":\"classes/BuildImageDataStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageDataStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":1024,\"name\":\"bucket\",\"url\":\"classes/BuildImageDataStack.html#bucket\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":2048,\"name\":\"createDeploymentBucket\",\"url\":\"classes/BuildImageDataStack.html#createDeploymentBucket\",\"classes\":\"tsd-is-private\",\"parent\":\"BuildImageDataStack\"},{\"kind\":128,\"name\":\"BuildImageRepoStack\",\"url\":\"classes/BuildImageRepoStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageRepoStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"classes/BuildImageRepoStack.html#repository\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":8,\"name\":\"ImageKind\",\"url\":\"enums/ImageKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Ubuntu22_04\",\"url\":\"enums/ImageKind.html#Ubuntu22_04\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":16,\"name\":\"Fedora37\",\"url\":\"enums/ImageKind.html#Fedora37\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":16,\"name\":\"Debian11\",\"url\":\"enums/ImageKind.html#Debian11\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":256,\"name\":\"BuildImagePipelineProps\",\"url\":\"interfaces/BuildImagePipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageKind\",\"url\":\"interfaces/BuildImagePipelineProps.html#imageKind\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"dataBucket\",\"url\":\"interfaces/BuildImagePipelineProps.html#dataBucket\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"interfaces/BuildImagePipelineProps.html#repository\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":128,\"name\":\"BuildImagePipelineStack\",\"url\":\"classes/BuildImagePipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImagePipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImagePipelineStack\"},{\"kind\":256,\"name\":\"DemoPipelineProps\",\"url\":\"interfaces/DemoPipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageRepo\",\"url\":\"interfaces/DemoPipelineProps.html#imageRepo\",\"classes\":\"\",\"parent\":\"DemoPipelineProps\"},{\"kind\":1024,\"name\":\"imageTag\",\"url\":\"interfaces/DemoPipelineProps.html#imageTag\",\"classes\":\"\",\"parent\":\"DemoPipelineProps\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"interfaces/DemoPipelineProps.html#vpc\",\"classes\":\"\",\"parent\":\"DemoPipelineProps\"},{\"kind\":1024,\"name\":\"projectKind\",\"url\":\"interfaces/DemoPipelineProps.html#projectKind\",\"classes\":\"\",\"parent\":\"DemoPipelineProps\"},{\"kind\":1024,\"name\":\"layerRepoName\",\"url\":\"interfaces/DemoPipelineProps.html#layerRepoName\",\"classes\":\"\",\"parent\":\"DemoPipelineProps\"},{\"kind\":128,\"name\":\"DemoPipelineStack\",\"url\":\"classes/DemoPipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/DemoPipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addFileSystem\",\"url\":\"classes/DemoPipelineStack.html#addFileSystem\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addVMExportPolicy\",\"url\":\"classes/DemoPipelineStack.html#addVMExportPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIS3BackupPolicy\",\"url\":\"classes/DemoPipelineStack.html#addAMIS3BackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEBSBackupPolicy\",\"url\":\"classes/DemoPipelineStack.html#addAMIEBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIBackupPolicy\",\"url\":\"classes/DemoPipelineStack.html#addAMIBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEC2EBSBackupPolicy\",\"url\":\"classes/DemoPipelineStack.html#addAMIEC2EBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"DemoPipelineStack\"},{\"kind\":8,\"name\":\"ProjectKind\",\"url\":\"enums/ProjectKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Poky\",\"url\":\"enums/ProjectKind.html#Poky\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"MetaAwsDemo\",\"url\":\"enums/ProjectKind.html#MetaAwsDemo\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"PokyAmi\",\"url\":\"enums/ProjectKind.html#PokyAmi\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Kas\",\"url\":\"enums/ProjectKind.html#Kas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Renesas\",\"url\":\"enums/ProjectKind.html#Renesas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"NxpImx\",\"url\":\"enums/ProjectKind.html#NxpImx\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":256,\"name\":\"SourceRepoProps\",\"url\":\"interfaces/SourceRepoProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"repoName\",\"url\":\"interfaces/SourceRepoProps.html#repoName\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":1024,\"name\":\"kind\",\"url\":\"interfaces/SourceRepoProps.html#kind\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":128,\"name\":\"SourceRepo\",\"url\":\"classes/SourceRepo.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/SourceRepo.html#constructor\",\"classes\":\"\",\"parent\":\"SourceRepo\"},{\"kind\":1024,\"name\":\"repo\",\"url\":\"classes/SourceRepo.html#repo\",\"classes\":\"\",\"parent\":\"SourceRepo\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,35.066]],[\"comment/0\",[]],[\"name/1\",[1,20.402]],[\"comment/1\",[]],[\"name/2\",[2,29.957]],[\"comment/2\",[]],[\"name/3\",[3,35.066]],[\"comment/3\",[]],[\"name/4\",[4,35.066]],[\"comment/4\",[]],[\"name/5\",[5,35.066]],[\"comment/5\",[]],[\"name/6\",[1,20.402]],[\"comment/6\",[]],[\"name/7\",[6,35.066]],[\"comment/7\",[]],[\"name/8\",[7,35.066]],[\"comment/8\",[]],[\"name/9\",[8,35.066]],[\"comment/9\",[]],[\"name/10\",[1,20.402]],[\"comment/10\",[]],[\"name/11\",[9,29.957]],[\"comment/11\",[]],[\"name/12\",[10,29.957]],[\"comment/12\",[]],[\"name/13\",[11,35.066]],[\"comment/13\",[]],[\"name/14\",[12,35.066]],[\"comment/14\",[]],[\"name/15\",[13,35.066]],[\"comment/15\",[]],[\"name/16\",[14,35.066]],[\"comment/16\",[]],[\"name/17\",[10,29.957]],[\"comment/17\",[]],[\"name/18\",[15,35.066]],[\"comment/18\",[]],[\"name/19\",[9,29.957]],[\"comment/19\",[]],[\"name/20\",[16,35.066]],[\"comment/20\",[]],[\"name/21\",[1,20.402]],[\"comment/21\",[]],[\"name/22\",[17,35.066]],[\"comment/22\",[]],[\"name/23\",[18,35.066]],[\"comment/23\",[]],[\"name/24\",[19,35.066]],[\"comment/24\",[]],[\"name/25\",[2,29.957]],[\"comment/25\",[]],[\"name/26\",[20,29.957]],[\"comment/26\",[]],[\"name/27\",[21,35.066]],[\"comment/27\",[]],[\"name/28\",[22,35.066]],[\"comment/28\",[]],[\"name/29\",[1,20.402]],[\"comment/29\",[]],[\"name/30\",[23,35.066]],[\"comment/30\",[]],[\"name/31\",[24,35.066]],[\"comment/31\",[]],[\"name/32\",[25,35.066]],[\"comment/32\",[]],[\"name/33\",[26,35.066]],[\"comment/33\",[]],[\"name/34\",[27,35.066]],[\"comment/34\",[]],[\"name/35\",[28,35.066]],[\"comment/35\",[]],[\"name/36\",[20,29.957]],[\"comment/36\",[]],[\"name/37\",[29,35.066]],[\"comment/37\",[]],[\"name/38\",[30,35.066]],[\"comment/38\",[]],[\"name/39\",[31,35.066]],[\"comment/39\",[]],[\"name/40\",[32,35.066]],[\"comment/40\",[]],[\"name/41\",[33,35.066]],[\"comment/41\",[]],[\"name/42\",[34,35.066]],[\"comment/42\",[]],[\"name/43\",[35,35.066]],[\"comment/43\",[]],[\"name/44\",[36,35.066]],[\"comment/44\",[]],[\"name/45\",[37,35.066]],[\"comment/45\",[]],[\"name/46\",[38,35.066]],[\"comment/46\",[]],[\"name/47\",[1,20.402]],[\"comment/47\",[]],[\"name/48\",[39,35.066]],[\"comment/48\",[]]],\"invertedIndex\":[[\"addamibackuppolicy\",{\"_index\":27,\"name\":{\"34\":{}},\"comment\":{}}],[\"addamiebsbackuppolicy\",{\"_index\":26,\"name\":{\"33\":{}},\"comment\":{}}],[\"addamiec2ebsbackuppolicy\",{\"_index\":28,\"name\":{\"35\":{}},\"comment\":{}}],[\"addamis3backuppolicy\",{\"_index\":25,\"name\":{\"32\":{}},\"comment\":{}}],[\"addfilesystem\",{\"_index\":23,\"name\":{\"30\":{}},\"comment\":{}}],[\"addvmexportpolicy\",{\"_index\":24,\"name\":{\"31\":{}},\"comment\":{}}],[\"bucket\",{\"_index\":6,\"name\":{\"7\":{}},\"comment\":{}}],[\"bucketname\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"buildimagedataprops\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"buildimagedatastack\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"buildimagepipelineprops\",{\"_index\":14,\"name\":{\"16\":{}},\"comment\":{}}],[\"buildimagepipelinestack\",{\"_index\":16,\"name\":{\"20\":{}},\"comment\":{}}],[\"buildimagerepostack\",{\"_index\":8,\"name\":{\"9\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{},\"6\":{},\"10\":{},\"21\":{},\"29\":{},\"47\":{}},\"comment\":{}}],[\"createdeploymentbucket\",{\"_index\":7,\"name\":{\"8\":{}},\"comment\":{}}],[\"databucket\",{\"_index\":15,\"name\":{\"18\":{}},\"comment\":{}}],[\"debian11\",{\"_index\":13,\"name\":{\"15\":{}},\"comment\":{}}],[\"demopipelineprops\",{\"_index\":17,\"name\":{\"22\":{}},\"comment\":{}}],[\"demopipelinestack\",{\"_index\":22,\"name\":{\"28\":{}},\"comment\":{}}],[\"fedora37\",{\"_index\":12,\"name\":{\"14\":{}},\"comment\":{}}],[\"imagekind\",{\"_index\":10,\"name\":{\"12\":{},\"17\":{}},\"comment\":{}}],[\"imagerepo\",{\"_index\":18,\"name\":{\"23\":{}},\"comment\":{}}],[\"imagetag\",{\"_index\":19,\"name\":{\"24\":{}},\"comment\":{}}],[\"kas\",{\"_index\":32,\"name\":{\"40\":{}},\"comment\":{}}],[\"kind\",{\"_index\":37,\"name\":{\"45\":{}},\"comment\":{}}],[\"layerreponame\",{\"_index\":21,\"name\":{\"27\":{}},\"comment\":{}}],[\"metaawsdemo\",{\"_index\":30,\"name\":{\"38\":{}},\"comment\":{}}],[\"nxpimx\",{\"_index\":34,\"name\":{\"42\":{}},\"comment\":{}}],[\"pipelinenetworkstack\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"poky\",{\"_index\":29,\"name\":{\"37\":{}},\"comment\":{}}],[\"pokyami\",{\"_index\":31,\"name\":{\"39\":{}},\"comment\":{}}],[\"projectkind\",{\"_index\":20,\"name\":{\"26\":{},\"36\":{}},\"comment\":{}}],[\"renesas\",{\"_index\":33,\"name\":{\"41\":{}},\"comment\":{}}],[\"repo\",{\"_index\":39,\"name\":{\"48\":{}},\"comment\":{}}],[\"reponame\",{\"_index\":36,\"name\":{\"44\":{}},\"comment\":{}}],[\"repository\",{\"_index\":9,\"name\":{\"11\":{},\"19\":{}},\"comment\":{}}],[\"sourcerepo\",{\"_index\":38,\"name\":{\"46\":{}},\"comment\":{}}],[\"sourcerepoprops\",{\"_index\":35,\"name\":{\"43\":{}},\"comment\":{}}],[\"ubuntu22_04\",{\"_index\":11,\"name\":{\"13\":{}},\"comment\":{}}],[\"vpc\",{\"_index\":2,\"name\":{\"2\":{},\"25\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = JSON.parse("{\"rows\":[{\"kind\":128,\"name\":\"PipelineNetworkStack\",\"url\":\"classes/PipelineNetworkStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/PipelineNetworkStack.html#constructor\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"classes/PipelineNetworkStack.html#vpc\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":256,\"name\":\"BuildImageDataProps\",\"url\":\"interfaces/BuildImageDataProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"bucketName\",\"url\":\"interfaces/BuildImageDataProps.html#bucketName\",\"classes\":\"\",\"parent\":\"BuildImageDataProps\"},{\"kind\":128,\"name\":\"BuildImageDataStack\",\"url\":\"classes/BuildImageDataStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageDataStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":1024,\"name\":\"bucket\",\"url\":\"classes/BuildImageDataStack.html#bucket\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":2048,\"name\":\"createDeploymentBucket\",\"url\":\"classes/BuildImageDataStack.html#createDeploymentBucket\",\"classes\":\"tsd-is-private\",\"parent\":\"BuildImageDataStack\"},{\"kind\":128,\"name\":\"BuildImageRepoStack\",\"url\":\"classes/BuildImageRepoStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageRepoStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"classes/BuildImageRepoStack.html#repository\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":8,\"name\":\"ImageKind\",\"url\":\"enums/ImageKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Ubuntu22_04\",\"url\":\"enums/ImageKind.html#Ubuntu22_04\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":16,\"name\":\"Fedora37\",\"url\":\"enums/ImageKind.html#Fedora37\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":16,\"name\":\"Debian11\",\"url\":\"enums/ImageKind.html#Debian11\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":256,\"name\":\"BuildImagePipelineProps\",\"url\":\"interfaces/BuildImagePipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageKind\",\"url\":\"interfaces/BuildImagePipelineProps.html#imageKind\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"dataBucket\",\"url\":\"interfaces/BuildImagePipelineProps.html#dataBucket\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"interfaces/BuildImagePipelineProps.html#repository\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":128,\"name\":\"BuildImagePipelineStack\",\"url\":\"classes/BuildImagePipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImagePipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImagePipelineStack\"},{\"kind\":256,\"name\":\"EmbeddedLinuxPipelineProps\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageRepo\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#imageRepo\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"imageTag\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#imageTag\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#vpc\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"projectKind\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#projectKind\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"layerRepoName\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#layerRepoName\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":128,\"name\":\"EmbeddedLinuxPipelineStack\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addFileSystem\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addFileSystem\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addVMExportPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addVMExportPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIS3BackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIS3BackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEBSBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIEBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEC2EBSBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIEC2EBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":8,\"name\":\"ProjectKind\",\"url\":\"enums/ProjectKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Poky\",\"url\":\"enums/ProjectKind.html#Poky\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"MetaAwsDemo\",\"url\":\"enums/ProjectKind.html#MetaAwsDemo\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"PokyAmi\",\"url\":\"enums/ProjectKind.html#PokyAmi\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Kas\",\"url\":\"enums/ProjectKind.html#Kas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Renesas\",\"url\":\"enums/ProjectKind.html#Renesas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"NxpImx\",\"url\":\"enums/ProjectKind.html#NxpImx\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":256,\"name\":\"SourceRepoProps\",\"url\":\"interfaces/SourceRepoProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"repoName\",\"url\":\"interfaces/SourceRepoProps.html#repoName\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":1024,\"name\":\"kind\",\"url\":\"interfaces/SourceRepoProps.html#kind\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":128,\"name\":\"SourceRepo\",\"url\":\"classes/SourceRepo.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/SourceRepo.html#constructor\",\"classes\":\"\",\"parent\":\"SourceRepo\"},{\"kind\":1024,\"name\":\"repo\",\"url\":\"classes/SourceRepo.html#repo\",\"classes\":\"\",\"parent\":\"SourceRepo\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,35.066]],[\"comment/0\",[]],[\"name/1\",[1,20.402]],[\"comment/1\",[]],[\"name/2\",[2,29.957]],[\"comment/2\",[]],[\"name/3\",[3,35.066]],[\"comment/3\",[]],[\"name/4\",[4,35.066]],[\"comment/4\",[]],[\"name/5\",[5,35.066]],[\"comment/5\",[]],[\"name/6\",[1,20.402]],[\"comment/6\",[]],[\"name/7\",[6,35.066]],[\"comment/7\",[]],[\"name/8\",[7,35.066]],[\"comment/8\",[]],[\"name/9\",[8,35.066]],[\"comment/9\",[]],[\"name/10\",[1,20.402]],[\"comment/10\",[]],[\"name/11\",[9,29.957]],[\"comment/11\",[]],[\"name/12\",[10,29.957]],[\"comment/12\",[]],[\"name/13\",[11,35.066]],[\"comment/13\",[]],[\"name/14\",[12,35.066]],[\"comment/14\",[]],[\"name/15\",[13,35.066]],[\"comment/15\",[]],[\"name/16\",[14,35.066]],[\"comment/16\",[]],[\"name/17\",[10,29.957]],[\"comment/17\",[]],[\"name/18\",[15,35.066]],[\"comment/18\",[]],[\"name/19\",[9,29.957]],[\"comment/19\",[]],[\"name/20\",[16,35.066]],[\"comment/20\",[]],[\"name/21\",[1,20.402]],[\"comment/21\",[]],[\"name/22\",[17,35.066]],[\"comment/22\",[]],[\"name/23\",[18,35.066]],[\"comment/23\",[]],[\"name/24\",[19,35.066]],[\"comment/24\",[]],[\"name/25\",[2,29.957]],[\"comment/25\",[]],[\"name/26\",[20,29.957]],[\"comment/26\",[]],[\"name/27\",[21,35.066]],[\"comment/27\",[]],[\"name/28\",[22,35.066]],[\"comment/28\",[]],[\"name/29\",[1,20.402]],[\"comment/29\",[]],[\"name/30\",[23,35.066]],[\"comment/30\",[]],[\"name/31\",[24,35.066]],[\"comment/31\",[]],[\"name/32\",[25,35.066]],[\"comment/32\",[]],[\"name/33\",[26,35.066]],[\"comment/33\",[]],[\"name/34\",[27,35.066]],[\"comment/34\",[]],[\"name/35\",[28,35.066]],[\"comment/35\",[]],[\"name/36\",[20,29.957]],[\"comment/36\",[]],[\"name/37\",[29,35.066]],[\"comment/37\",[]],[\"name/38\",[30,35.066]],[\"comment/38\",[]],[\"name/39\",[31,35.066]],[\"comment/39\",[]],[\"name/40\",[32,35.066]],[\"comment/40\",[]],[\"name/41\",[33,35.066]],[\"comment/41\",[]],[\"name/42\",[34,35.066]],[\"comment/42\",[]],[\"name/43\",[35,35.066]],[\"comment/43\",[]],[\"name/44\",[36,35.066]],[\"comment/44\",[]],[\"name/45\",[37,35.066]],[\"comment/45\",[]],[\"name/46\",[38,35.066]],[\"comment/46\",[]],[\"name/47\",[1,20.402]],[\"comment/47\",[]],[\"name/48\",[39,35.066]],[\"comment/48\",[]]],\"invertedIndex\":[[\"addamibackuppolicy\",{\"_index\":27,\"name\":{\"34\":{}},\"comment\":{}}],[\"addamiebsbackuppolicy\",{\"_index\":26,\"name\":{\"33\":{}},\"comment\":{}}],[\"addamiec2ebsbackuppolicy\",{\"_index\":28,\"name\":{\"35\":{}},\"comment\":{}}],[\"addamis3backuppolicy\",{\"_index\":25,\"name\":{\"32\":{}},\"comment\":{}}],[\"addfilesystem\",{\"_index\":23,\"name\":{\"30\":{}},\"comment\":{}}],[\"addvmexportpolicy\",{\"_index\":24,\"name\":{\"31\":{}},\"comment\":{}}],[\"bucket\",{\"_index\":6,\"name\":{\"7\":{}},\"comment\":{}}],[\"bucketname\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"buildimagedataprops\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"buildimagedatastack\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"buildimagepipelineprops\",{\"_index\":14,\"name\":{\"16\":{}},\"comment\":{}}],[\"buildimagepipelinestack\",{\"_index\":16,\"name\":{\"20\":{}},\"comment\":{}}],[\"buildimagerepostack\",{\"_index\":8,\"name\":{\"9\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{},\"6\":{},\"10\":{},\"21\":{},\"29\":{},\"47\":{}},\"comment\":{}}],[\"createdeploymentbucket\",{\"_index\":7,\"name\":{\"8\":{}},\"comment\":{}}],[\"databucket\",{\"_index\":15,\"name\":{\"18\":{}},\"comment\":{}}],[\"debian11\",{\"_index\":13,\"name\":{\"15\":{}},\"comment\":{}}],[\"embeddedlinuxpipelineprops\",{\"_index\":17,\"name\":{\"22\":{}},\"comment\":{}}],[\"embeddedlinuxpipelinestack\",{\"_index\":22,\"name\":{\"28\":{}},\"comment\":{}}],[\"fedora37\",{\"_index\":12,\"name\":{\"14\":{}},\"comment\":{}}],[\"imagekind\",{\"_index\":10,\"name\":{\"12\":{},\"17\":{}},\"comment\":{}}],[\"imagerepo\",{\"_index\":18,\"name\":{\"23\":{}},\"comment\":{}}],[\"imagetag\",{\"_index\":19,\"name\":{\"24\":{}},\"comment\":{}}],[\"kas\",{\"_index\":32,\"name\":{\"40\":{}},\"comment\":{}}],[\"kind\",{\"_index\":37,\"name\":{\"45\":{}},\"comment\":{}}],[\"layerreponame\",{\"_index\":21,\"name\":{\"27\":{}},\"comment\":{}}],[\"metaawsdemo\",{\"_index\":30,\"name\":{\"38\":{}},\"comment\":{}}],[\"nxpimx\",{\"_index\":34,\"name\":{\"42\":{}},\"comment\":{}}],[\"pipelinenetworkstack\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"poky\",{\"_index\":29,\"name\":{\"37\":{}},\"comment\":{}}],[\"pokyami\",{\"_index\":31,\"name\":{\"39\":{}},\"comment\":{}}],[\"projectkind\",{\"_index\":20,\"name\":{\"26\":{},\"36\":{}},\"comment\":{}}],[\"renesas\",{\"_index\":33,\"name\":{\"41\":{}},\"comment\":{}}],[\"repo\",{\"_index\":39,\"name\":{\"48\":{}},\"comment\":{}}],[\"reponame\",{\"_index\":36,\"name\":{\"44\":{}},\"comment\":{}}],[\"repository\",{\"_index\":9,\"name\":{\"11\":{},\"19\":{}},\"comment\":{}}],[\"sourcerepo\",{\"_index\":38,\"name\":{\"46\":{}},\"comment\":{}}],[\"sourcerepoprops\",{\"_index\":35,\"name\":{\"43\":{}},\"comment\":{}}],[\"ubuntu22_04\",{\"_index\":11,\"name\":{\"13\":{}},\"comment\":{}}],[\"vpc\",{\"_index\":2,\"name\":{\"2\":{},\"25\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html index f9d8384..9ee0d13 100644 --- a/classes/BuildImageDataStack.html +++ b/classes/BuildImageDataStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:22
    • @@ -116,7 +116,7 @@
    props: Returns BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:26

    • Properties

    @@ -179,7 +179,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:24

    • Readonly environment

    environment: string
    @@ -720,7 +720,7 @@
    bucketName: Returns IBucket
    +
  • Defined in lib/build-image-data.ts:38

    • exportStringListValue

    Generated using TypeDoc

    diff --git a/classes/BuildImagePipelineStack.html b/classes/BuildImagePipelineStack.html index 9038c08..082705a 100644 --- a/classes/BuildImagePipelineStack.html +++ b/classes/BuildImagePipelineStack.html @@ -27,7 +27,7 @@

    Hierarchy

    • BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:42
    • @@ -115,7 +115,7 @@
    props: Returns BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:43

    • Properties

    @@ -1158,12 +1158,12 @@

    BuildImageDataStack
  • BuildImagePipelineStack
  • BuildImageRepoStack
    • -
  • DemoPipelineStack
    • +
  • EmbeddedLinuxPipelineStack
  • PipelineNetworkStack
  • SourceRepo
  • BuildImageDataProps
  • BuildImagePipelineProps
    • -
  • DemoPipelineProps
    • +
  • EmbeddedLinuxPipelineProps
  • SourceRepoProps

    • Generated using TypeDoc

    diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html index 88cb41a..5945b36 100644 --- a/classes/BuildImageRepoStack.html +++ b/classes/BuildImageRepoStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:8
    • @@ -115,7 +115,7 @@
    Optional Returns BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:12

    • Properties

    @@ -239,7 +239,7 @@

    Readonly

    +
  • Defined in lib/build-image-repo.ts:10

    • Readonly synthesizer

    synthesizer: IStackSynthesizer
    @@ -1167,12 +1167,12 @@

    BuildImageDataStack
  • BuildImagePipelineStack
  • BuildImageRepoStack
    • -
  • DemoPipelineStack
    • +
  • EmbeddedLinuxPipelineStack
  • PipelineNetworkStack
  • SourceRepo
  • BuildImageDataProps
  • BuildImagePipelineProps
    • -
  • DemoPipelineProps
    • +
  • EmbeddedLinuxPipelineProps
  • SourceRepoProps

    • Generated using TypeDoc

    diff --git a/classes/DemoPipelineStack.html b/classes/EmbeddedLinuxPipelineStack.html similarity index 87% rename from classes/DemoPipelineStack.html rename to classes/EmbeddedLinuxPipelineStack.html index 8d74444..cdb98f0 100644 --- a/classes/DemoPipelineStack.html +++ b/classes/EmbeddedLinuxPipelineStack.html @@ -1,4 +1,4 @@ -DemoPipelineStack | aws4embeddedlinux-cdk-lib
    +EmbeddedLinuxPipelineStack | aws4embeddedlinux-cdk-lib

    The stack demonstrating how to build a pipeline for meta-aws-demos

    @@ -24,9 +24,9 @@

    Hierarchy

    • Stack
        -
      • DemoPipelineStack

    +
  • Defined in lib/embedded-linux-pipeline.ts:56
    • @@ -34,79 +34,79 @@

    Constructors

    constructor

    -

    Returns DemoPipelineStack

    +
  • Defined in lib/embedded-linux-pipeline.ts:57

    • Properties

    @@ -585,7 +585,7 @@

    Private

  • Returns PolicyStatement

    • +
  • Defined in lib/embedded-linux-pipeline.ts:393

    • Private addAMIEBSBackupPolicy

      @@ -598,7 +598,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:380

    • Private addAMIEC2EBSBackupPolicy

      @@ -611,7 +611,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:400

    • Private addAMIS3BackupPolicy

      @@ -624,7 +624,7 @@

      Parameters

      artifactBucketArn: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:368

    • addDependency

    +
  • Defined in lib/embedded-linux-pipeline.ts:336

    • addMetadata

    +
  • Defined in lib/embedded-linux-pipeline.ts:353

    • Protected allocateLogicalId

    Generated using TypeDoc

    diff --git a/classes/PipelineNetworkStack.html b/classes/PipelineNetworkStack.html index 14125a1..d9d415c 100644 --- a/classes/PipelineNetworkStack.html +++ b/classes/PipelineNetworkStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • PipelineNetworkStack
    +
  • Defined in lib/network.ts:9
    • @@ -113,7 +113,7 @@
    Optional Returns PipelineNetworkStack
    +
  • Defined in lib/network.ts:13

    • Properties

    @@ -284,7 +284,7 @@

    Readonly

    +
  • Defined in lib/network.ts:11

    • Accessors

    @@ -1165,12 +1165,12 @@

    BuildImageDataStack
  • BuildImagePipelineStack
  • BuildImageRepoStack
    • -
  • DemoPipelineStack
    • +
  • EmbeddedLinuxPipelineStack
  • PipelineNetworkStack
  • SourceRepo
  • BuildImageDataProps
  • BuildImagePipelineProps
    • -
  • DemoPipelineProps
    • +
  • EmbeddedLinuxPipelineProps
  • SourceRepoProps

    • Generated using TypeDoc

    diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html index d22b57c..a7c41a5 100644 --- a/classes/SourceRepo.html +++ b/classes/SourceRepo.html @@ -26,7 +26,7 @@

    Hierarchy

    • SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:35
    • @@ -65,7 +65,7 @@
    props: Returns SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:39

    • Properties

    @@ -84,7 +84,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:37

    • Methods

    @@ -164,12 +164,12 @@

    BuildImageDataStack
  • BuildImagePipelineStack
  • BuildImageRepoStack
    • -
  • DemoPipelineStack
    • +
  • EmbeddedLinuxPipelineStack
  • PipelineNetworkStack
  • SourceRepo
  • BuildImageDataProps
  • BuildImagePipelineProps
    • -
  • DemoPipelineProps
    • +
  • EmbeddedLinuxPipelineProps
  • SourceRepoProps

    • Generated using TypeDoc

    diff --git a/enums/ImageKind.html b/enums/ImageKind.html index f3f4363..651f835 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -20,7 +20,7 @@

    Enumeration ImageKind

    +
  • Defined in lib/build-image-pipeline.ts:17
    • @@ -41,7 +41,7 @@

    Debian11

    +
  • Defined in lib/build-image-pipeline.ts:23

    • Fedora37

    Fedora37: "fedora_37"
    @@ -49,7 +49,7 @@

    Fedora37

    +
  • Defined in lib/build-image-pipeline.ts:21

    • Ubuntu22_04

    Ubuntu22_04: "ubuntu_22_04"
    @@ -57,7 +57,7 @@

    Ubuntu22_04

    +
  • Defined in lib/build-image-pipeline.ts:19
    • @@ -88,12 +88,12 @@

    BuildImageDataStack
  • BuildImagePipelineStack
  • BuildImageRepoStack
    • -
  • DemoPipelineStack
    • +
  • EmbeddedLinuxPipelineStack
  • PipelineNetworkStack
  • SourceRepo
  • BuildImageDataProps
  • BuildImagePipelineProps
    • -
  • DemoPipelineProps
    • +
  • EmbeddedLinuxPipelineProps
  • SourceRepoProps

    • Generated using TypeDoc

    diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html index bb30098..19959aa 100644 --- a/enums/ProjectKind.html +++ b/enums/ProjectKind.html @@ -20,7 +20,7 @@

    Enumeration ProjectKind

    +
  • Defined in lib/constructs/source-repo.ts:10
    • @@ -44,7 +44,7 @@

    Kas

    +
  • Defined in lib/constructs/source-repo.ts:18

    • MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"
    @@ -52,7 +52,7 @@

    MetaAwsDemo

    +
  • Defined in lib/constructs/source-repo.ts:14

    • NxpImx

    NxpImx: "nxp-imx"
    @@ -60,7 +60,7 @@

    NxpImx

    +
  • Defined in lib/constructs/source-repo.ts:22

    • Poky

    Poky: "poky"
    @@ -68,7 +68,7 @@

    Poky

    +
  • Defined in lib/constructs/source-repo.ts:12

    • PokyAmi

    PokyAmi: "poky-ami"
    @@ -76,7 +76,7 @@

    PokyAmi

    +
  • Defined in lib/constructs/source-repo.ts:16

    • Renesas

    Renesas: "renesas"
    @@ -84,7 +84,7 @@

    Renesas

    +
  • Defined in lib/constructs/source-repo.ts:20
    • @@ -118,12 +118,12 @@

    BuildImageDataStack
  • BuildImagePipelineStack
  • BuildImageRepoStack
    • -
  • DemoPipelineStack
    • +
  • EmbeddedLinuxPipelineStack
  • PipelineNetworkStack
  • SourceRepo
  • BuildImageDataProps
  • BuildImagePipelineProps
    • -
  • DemoPipelineProps
    • +
  • EmbeddedLinuxPipelineProps
  • SourceRepoProps

    • Generated using TypeDoc

    diff --git a/index.html b/index.html index 5d40833..394ee0d 100644 --- a/index.html +++ b/index.html @@ -25,7 +25,7 @@

    Classes

    BuildImageDataStack BuildImagePipelineStack BuildImageRepoStack -DemoPipelineStack +EmbeddedLinuxPipelineStack PipelineNetworkStack SourceRepo
    @@ -33,7 +33,7 @@

    Classes

    Interfaces

    BuildImageDataProps BuildImagePipelineProps -DemoPipelineProps +EmbeddedLinuxPipelineProps SourceRepoProps
    @@ -59,12 +59,12 @@

    Theme

    @@ -13,8 +13,8 @@
    -

    Interface DemoPipelineProps

    +
  • EmbeddedLinuxPipelineProps
    • +

    Interface EmbeddedLinuxPipelineProps

    Properties to allow customizing the build.

    @@ -24,9 +24,9 @@

    Hierarchy

    • StackProps
        -
      • DemoPipelineProps
    @@ -34,21 +34,21 @@

    Properties

    @@ -131,7 +131,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:42

    • Optional Readonly imageTag

    imageTag?: string
    @@ -139,7 +139,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:44

    • Optional Readonly layerRepoName

    layerRepoName?: string
    @@ -147,7 +147,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:50

    • Optional Readonly permissionsBoundary

    permissionsBoundary?: PermissionsBoundary
    @@ -168,7 +168,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:48

    • Optional Readonly stackName

    stackName?: string
    @@ -255,7 +255,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:46
    • @@ -298,12 +298,12 @@

    BuildImageDataStack
  • BuildImagePipelineStack
  • BuildImageRepoStack
    • -
  • DemoPipelineStack
    • +
  • EmbeddedLinuxPipelineStack
  • PipelineNetworkStack
  • SourceRepo
  • BuildImageDataProps
  • BuildImagePipelineProps
    • -
  • DemoPipelineProps
    • +
  • EmbeddedLinuxPipelineProps
  • SourceRepoProps

    • Generated using TypeDoc

    diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html index cee58eb..83f5af0 100644 --- a/interfaces/SourceRepoProps.html +++ b/interfaces/SourceRepoProps.html @@ -22,7 +22,7 @@

    Hierarchy

    • SourceRepoProps
    +
  • Defined in lib/constructs/source-repo.ts:25
    • @@ -124,7 +124,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:29

    • Optional Readonly permissionsBoundary

    permissionsBoundary?: PermissionsBoundary
    @@ -145,7 +145,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:27

    • Optional Readonly stackName

    stackName?: string
    @@ -264,12 +264,12 @@

    BuildImageDataStack
  • BuildImagePipelineStack
  • BuildImageRepoStack
    • -
  • DemoPipelineStack
    • +
  • EmbeddedLinuxPipelineStack
  • PipelineNetworkStack
  • SourceRepo
  • BuildImageDataProps
  • BuildImagePipelineProps
    • -
  • DemoPipelineProps
    • +
  • EmbeddedLinuxPipelineProps
  • SourceRepoProps

    • Generated using TypeDoc

    From 99af094cb9777c4f9b71ef1c89bf0da321531fa2 Mon Sep 17 00:00:00 2001 From: nateglims Date: Tue, 21 Nov 2023 18:26:34 +0000 Subject: [PATCH 06/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@c8fd5bd4b9d3ca5b6b2b934df5?= =?UTF-8?q?9d9f99fc4c016e=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/BuildImageDataStack.html | 8 ++++---- classes/BuildImagePipelineStack.html | 4 ++-- classes/BuildImageRepoStack.html | 6 +++--- classes/EmbeddedLinuxPipelineStack.html | 16 ++++++++-------- classes/PipelineNetworkStack.html | 6 +++--- classes/SourceRepo.html | 6 +++--- enums/ImageKind.html | 8 ++++---- enums/ProjectKind.html | 14 +++++++------- interfaces/BuildImageDataProps.html | 4 ++-- interfaces/BuildImagePipelineProps.html | 8 ++++---- interfaces/EmbeddedLinuxPipelineProps.html | 12 ++++++------ interfaces/SourceRepoProps.html | 6 +++--- 12 files changed, 49 insertions(+), 49 deletions(-) diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html index 9ee0d13..5317938 100644 --- a/classes/BuildImageDataStack.html +++ b/classes/BuildImageDataStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataStack

    +
  • Defined in lib/build-image-data.ts:22
    • @@ -116,7 +116,7 @@
    props: Returns BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:26

    • Properties

    @@ -179,7 +179,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:24

    • Readonly environment

    environment: string
    @@ -720,7 +720,7 @@
    bucketName: Returns IBucket
    +
  • Defined in lib/build-image-data.ts:38

    • exportStringListValue

      diff --git a/classes/BuildImagePipelineStack.html b/classes/BuildImagePipelineStack.html index 082705a..cbdfd74 100644 --- a/classes/BuildImagePipelineStack.html +++ b/classes/BuildImagePipelineStack.html @@ -27,7 +27,7 @@

      Hierarchy

      • BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:42
    • @@ -115,7 +115,7 @@
    props: Returns BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:43

    • Properties

    diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html index 5945b36..3b49cc1 100644 --- a/classes/BuildImageRepoStack.html +++ b/classes/BuildImageRepoStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:8
    • @@ -115,7 +115,7 @@
    Optional Returns BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:12

    • Properties

    @@ -239,7 +239,7 @@

    Readonly

    +
  • Defined in lib/build-image-repo.ts:10

    • Readonly synthesizer

    synthesizer: IStackSynthesizer
    diff --git a/classes/EmbeddedLinuxPipelineStack.html b/classes/EmbeddedLinuxPipelineStack.html index cdb98f0..0115b80 100644 --- a/classes/EmbeddedLinuxPipelineStack.html +++ b/classes/EmbeddedLinuxPipelineStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:56
    • @@ -120,7 +120,7 @@
    props: Returns EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:57

    • Properties

    @@ -585,7 +585,7 @@

    Private

  • Returns PolicyStatement

    • +
  • Defined in lib/embedded-linux-pipeline.ts:393

    • Private addAMIEBSBackupPolicy

      @@ -598,7 +598,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:380

    • Private addAMIEC2EBSBackupPolicy

      @@ -611,7 +611,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:400

    • Private addAMIS3BackupPolicy

      @@ -624,7 +624,7 @@

      Parameters

      artifactBucketArn: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:368

    • addDependency

    +
  • Defined in lib/embedded-linux-pipeline.ts:336

    • addMetadata

    +
  • Defined in lib/embedded-linux-pipeline.ts:353

    • Protected allocateLogicalId

      diff --git a/classes/PipelineNetworkStack.html b/classes/PipelineNetworkStack.html index d9d415c..6cd0550 100644 --- a/classes/PipelineNetworkStack.html +++ b/classes/PipelineNetworkStack.html @@ -26,7 +26,7 @@

      Hierarchy

      • PipelineNetworkStack
    +
  • Defined in lib/network.ts:9
    • @@ -113,7 +113,7 @@
    Optional Returns PipelineNetworkStack
    +
  • Defined in lib/network.ts:13

    • Properties

    @@ -284,7 +284,7 @@

    Readonly

    +
  • Defined in lib/network.ts:11

    • Accessors

    diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html index a7c41a5..a54335c 100644 --- a/classes/SourceRepo.html +++ b/classes/SourceRepo.html @@ -26,7 +26,7 @@

    Hierarchy

    • SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:35
    • @@ -65,7 +65,7 @@
    props: Returns SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:39

    • Properties

    @@ -84,7 +84,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:37

    • Methods

    diff --git a/enums/ImageKind.html b/enums/ImageKind.html index 651f835..cbd62ff 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -20,7 +20,7 @@

    Enumeration ImageKind

    +
  • Defined in lib/build-image-pipeline.ts:17
    • @@ -41,7 +41,7 @@

    Debian11

    +
  • Defined in lib/build-image-pipeline.ts:23

    • Fedora37

    Fedora37: "fedora_37"
    @@ -49,7 +49,7 @@

    Fedora37

    +
  • Defined in lib/build-image-pipeline.ts:21

    • Ubuntu22_04

    Ubuntu22_04: "ubuntu_22_04"
    @@ -57,7 +57,7 @@

    Ubuntu22_04

    +
  • Defined in lib/build-image-pipeline.ts:19
    • diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html index 19959aa..a62d2a9 100644 --- a/enums/ProjectKind.html +++ b/enums/ProjectKind.html @@ -20,7 +20,7 @@

    Enumeration ProjectKind

    +
  • Defined in lib/constructs/source-repo.ts:10
    • @@ -44,7 +44,7 @@

    Kas

    +
  • Defined in lib/constructs/source-repo.ts:18

    • MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"
    @@ -52,7 +52,7 @@

    MetaAwsDemo

    +
  • Defined in lib/constructs/source-repo.ts:14

    • NxpImx

    NxpImx: "nxp-imx"
    @@ -60,7 +60,7 @@

    NxpImx

    +
  • Defined in lib/constructs/source-repo.ts:22

    • Poky

    Poky: "poky"
    @@ -68,7 +68,7 @@

    Poky

    +
  • Defined in lib/constructs/source-repo.ts:12

    • PokyAmi

    PokyAmi: "poky-ami"
    @@ -76,7 +76,7 @@

    PokyAmi

    +
  • Defined in lib/constructs/source-repo.ts:16

    • Renesas

    Renesas: "renesas"
    @@ -84,7 +84,7 @@

    Renesas

    +
  • Defined in lib/constructs/source-repo.ts:20
    • diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html index a24aacb..557b5fa 100644 --- a/interfaces/BuildImageDataProps.html +++ b/interfaces/BuildImageDataProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataProps
    +
  • Defined in lib/build-image-data.ts:14
    • @@ -67,7 +67,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:16

    • Optional Readonly crossRegionReferences

    crossRegionReferences?: boolean
    diff --git a/interfaces/BuildImagePipelineProps.html b/interfaces/BuildImagePipelineProps.html index fa7471e..c8e7b71 100644 --- a/interfaces/BuildImagePipelineProps.html +++ b/interfaces/BuildImagePipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImagePipelineProps
    +
  • Defined in lib/build-image-pipeline.ts:29
    • @@ -84,7 +84,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:33

    • Optional Readonly description

    description?: string
    @@ -137,7 +137,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:31

    • Optional Readonly permissionsBoundary

    permissionsBoundary?: PermissionsBoundary
    @@ -158,7 +158,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:35

    • Optional Readonly stackName

    stackName?: string
    diff --git a/interfaces/EmbeddedLinuxPipelineProps.html b/interfaces/EmbeddedLinuxPipelineProps.html index 5bcbd1d..4e4cbdb 100644 --- a/interfaces/EmbeddedLinuxPipelineProps.html +++ b/interfaces/EmbeddedLinuxPipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • EmbeddedLinuxPipelineProps
    +
  • Defined in lib/embedded-linux-pipeline.ts:40
    • @@ -131,7 +131,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:42

    • Optional Readonly imageTag

    imageTag?: string
    @@ -139,7 +139,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:44

    • Optional Readonly layerRepoName

    layerRepoName?: string
    @@ -147,7 +147,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:50

    • Optional Readonly permissionsBoundary

    permissionsBoundary?: PermissionsBoundary
    @@ -168,7 +168,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:48

    • Optional Readonly stackName

    stackName?: string
    @@ -255,7 +255,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:46
    • diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html index 83f5af0..af2faf8 100644 --- a/interfaces/SourceRepoProps.html +++ b/interfaces/SourceRepoProps.html @@ -22,7 +22,7 @@

    Hierarchy

    • SourceRepoProps
    +
  • Defined in lib/constructs/source-repo.ts:25
    • @@ -124,7 +124,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:29

    • Optional Readonly permissionsBoundary

    permissionsBoundary?: PermissionsBoundary
    @@ -145,7 +145,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:27

    • Optional Readonly stackName

    stackName?: string
    From 3690fd01d1be5239cbdccdd6035faca9715046d4 Mon Sep 17 00:00:00 2001 From: nateglims Date: Tue, 21 Nov 2023 18:35:51 +0000 Subject: [PATCH 07/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@0dd571ffcc9b489ae0d63601ba?= =?UTF-8?q?b71e35d5b9e7f9=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- assets/search.js | 2 +- classes/BuildImageDataStack.html | 8 +++---- classes/BuildImagePipelineStack.html | 4 ++-- classes/BuildImageRepoStack.html | 6 ++--- classes/EmbeddedLinuxPipelineStack.html | 16 ++++++------- classes/PipelineNetworkStack.html | 6 ++--- classes/SourceRepo.html | 6 ++--- enums/ImageKind.html | 28 ++++------------------ enums/ProjectKind.html | 14 +++++------ interfaces/BuildImageDataProps.html | 4 ++-- interfaces/BuildImagePipelineProps.html | 10 ++++---- interfaces/EmbeddedLinuxPipelineProps.html | 12 +++++----- interfaces/SourceRepoProps.html | 6 ++--- 13 files changed, 51 insertions(+), 71 deletions(-) diff --git a/assets/search.js b/assets/search.js index c0d2729..b2c8999 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"rows\":[{\"kind\":128,\"name\":\"PipelineNetworkStack\",\"url\":\"classes/PipelineNetworkStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/PipelineNetworkStack.html#constructor\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"classes/PipelineNetworkStack.html#vpc\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":256,\"name\":\"BuildImageDataProps\",\"url\":\"interfaces/BuildImageDataProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"bucketName\",\"url\":\"interfaces/BuildImageDataProps.html#bucketName\",\"classes\":\"\",\"parent\":\"BuildImageDataProps\"},{\"kind\":128,\"name\":\"BuildImageDataStack\",\"url\":\"classes/BuildImageDataStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageDataStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":1024,\"name\":\"bucket\",\"url\":\"classes/BuildImageDataStack.html#bucket\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":2048,\"name\":\"createDeploymentBucket\",\"url\":\"classes/BuildImageDataStack.html#createDeploymentBucket\",\"classes\":\"tsd-is-private\",\"parent\":\"BuildImageDataStack\"},{\"kind\":128,\"name\":\"BuildImageRepoStack\",\"url\":\"classes/BuildImageRepoStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageRepoStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"classes/BuildImageRepoStack.html#repository\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":8,\"name\":\"ImageKind\",\"url\":\"enums/ImageKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Ubuntu22_04\",\"url\":\"enums/ImageKind.html#Ubuntu22_04\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":16,\"name\":\"Fedora37\",\"url\":\"enums/ImageKind.html#Fedora37\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":16,\"name\":\"Debian11\",\"url\":\"enums/ImageKind.html#Debian11\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":256,\"name\":\"BuildImagePipelineProps\",\"url\":\"interfaces/BuildImagePipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageKind\",\"url\":\"interfaces/BuildImagePipelineProps.html#imageKind\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"dataBucket\",\"url\":\"interfaces/BuildImagePipelineProps.html#dataBucket\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"interfaces/BuildImagePipelineProps.html#repository\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":128,\"name\":\"BuildImagePipelineStack\",\"url\":\"classes/BuildImagePipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImagePipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImagePipelineStack\"},{\"kind\":256,\"name\":\"EmbeddedLinuxPipelineProps\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageRepo\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#imageRepo\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"imageTag\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#imageTag\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#vpc\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"projectKind\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#projectKind\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"layerRepoName\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#layerRepoName\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":128,\"name\":\"EmbeddedLinuxPipelineStack\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addFileSystem\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addFileSystem\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addVMExportPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addVMExportPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIS3BackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIS3BackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEBSBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIEBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEC2EBSBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIEC2EBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":8,\"name\":\"ProjectKind\",\"url\":\"enums/ProjectKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Poky\",\"url\":\"enums/ProjectKind.html#Poky\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"MetaAwsDemo\",\"url\":\"enums/ProjectKind.html#MetaAwsDemo\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"PokyAmi\",\"url\":\"enums/ProjectKind.html#PokyAmi\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Kas\",\"url\":\"enums/ProjectKind.html#Kas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Renesas\",\"url\":\"enums/ProjectKind.html#Renesas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"NxpImx\",\"url\":\"enums/ProjectKind.html#NxpImx\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":256,\"name\":\"SourceRepoProps\",\"url\":\"interfaces/SourceRepoProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"repoName\",\"url\":\"interfaces/SourceRepoProps.html#repoName\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":1024,\"name\":\"kind\",\"url\":\"interfaces/SourceRepoProps.html#kind\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":128,\"name\":\"SourceRepo\",\"url\":\"classes/SourceRepo.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/SourceRepo.html#constructor\",\"classes\":\"\",\"parent\":\"SourceRepo\"},{\"kind\":1024,\"name\":\"repo\",\"url\":\"classes/SourceRepo.html#repo\",\"classes\":\"\",\"parent\":\"SourceRepo\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,35.066]],[\"comment/0\",[]],[\"name/1\",[1,20.402]],[\"comment/1\",[]],[\"name/2\",[2,29.957]],[\"comment/2\",[]],[\"name/3\",[3,35.066]],[\"comment/3\",[]],[\"name/4\",[4,35.066]],[\"comment/4\",[]],[\"name/5\",[5,35.066]],[\"comment/5\",[]],[\"name/6\",[1,20.402]],[\"comment/6\",[]],[\"name/7\",[6,35.066]],[\"comment/7\",[]],[\"name/8\",[7,35.066]],[\"comment/8\",[]],[\"name/9\",[8,35.066]],[\"comment/9\",[]],[\"name/10\",[1,20.402]],[\"comment/10\",[]],[\"name/11\",[9,29.957]],[\"comment/11\",[]],[\"name/12\",[10,29.957]],[\"comment/12\",[]],[\"name/13\",[11,35.066]],[\"comment/13\",[]],[\"name/14\",[12,35.066]],[\"comment/14\",[]],[\"name/15\",[13,35.066]],[\"comment/15\",[]],[\"name/16\",[14,35.066]],[\"comment/16\",[]],[\"name/17\",[10,29.957]],[\"comment/17\",[]],[\"name/18\",[15,35.066]],[\"comment/18\",[]],[\"name/19\",[9,29.957]],[\"comment/19\",[]],[\"name/20\",[16,35.066]],[\"comment/20\",[]],[\"name/21\",[1,20.402]],[\"comment/21\",[]],[\"name/22\",[17,35.066]],[\"comment/22\",[]],[\"name/23\",[18,35.066]],[\"comment/23\",[]],[\"name/24\",[19,35.066]],[\"comment/24\",[]],[\"name/25\",[2,29.957]],[\"comment/25\",[]],[\"name/26\",[20,29.957]],[\"comment/26\",[]],[\"name/27\",[21,35.066]],[\"comment/27\",[]],[\"name/28\",[22,35.066]],[\"comment/28\",[]],[\"name/29\",[1,20.402]],[\"comment/29\",[]],[\"name/30\",[23,35.066]],[\"comment/30\",[]],[\"name/31\",[24,35.066]],[\"comment/31\",[]],[\"name/32\",[25,35.066]],[\"comment/32\",[]],[\"name/33\",[26,35.066]],[\"comment/33\",[]],[\"name/34\",[27,35.066]],[\"comment/34\",[]],[\"name/35\",[28,35.066]],[\"comment/35\",[]],[\"name/36\",[20,29.957]],[\"comment/36\",[]],[\"name/37\",[29,35.066]],[\"comment/37\",[]],[\"name/38\",[30,35.066]],[\"comment/38\",[]],[\"name/39\",[31,35.066]],[\"comment/39\",[]],[\"name/40\",[32,35.066]],[\"comment/40\",[]],[\"name/41\",[33,35.066]],[\"comment/41\",[]],[\"name/42\",[34,35.066]],[\"comment/42\",[]],[\"name/43\",[35,35.066]],[\"comment/43\",[]],[\"name/44\",[36,35.066]],[\"comment/44\",[]],[\"name/45\",[37,35.066]],[\"comment/45\",[]],[\"name/46\",[38,35.066]],[\"comment/46\",[]],[\"name/47\",[1,20.402]],[\"comment/47\",[]],[\"name/48\",[39,35.066]],[\"comment/48\",[]]],\"invertedIndex\":[[\"addamibackuppolicy\",{\"_index\":27,\"name\":{\"34\":{}},\"comment\":{}}],[\"addamiebsbackuppolicy\",{\"_index\":26,\"name\":{\"33\":{}},\"comment\":{}}],[\"addamiec2ebsbackuppolicy\",{\"_index\":28,\"name\":{\"35\":{}},\"comment\":{}}],[\"addamis3backuppolicy\",{\"_index\":25,\"name\":{\"32\":{}},\"comment\":{}}],[\"addfilesystem\",{\"_index\":23,\"name\":{\"30\":{}},\"comment\":{}}],[\"addvmexportpolicy\",{\"_index\":24,\"name\":{\"31\":{}},\"comment\":{}}],[\"bucket\",{\"_index\":6,\"name\":{\"7\":{}},\"comment\":{}}],[\"bucketname\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"buildimagedataprops\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"buildimagedatastack\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"buildimagepipelineprops\",{\"_index\":14,\"name\":{\"16\":{}},\"comment\":{}}],[\"buildimagepipelinestack\",{\"_index\":16,\"name\":{\"20\":{}},\"comment\":{}}],[\"buildimagerepostack\",{\"_index\":8,\"name\":{\"9\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{},\"6\":{},\"10\":{},\"21\":{},\"29\":{},\"47\":{}},\"comment\":{}}],[\"createdeploymentbucket\",{\"_index\":7,\"name\":{\"8\":{}},\"comment\":{}}],[\"databucket\",{\"_index\":15,\"name\":{\"18\":{}},\"comment\":{}}],[\"debian11\",{\"_index\":13,\"name\":{\"15\":{}},\"comment\":{}}],[\"embeddedlinuxpipelineprops\",{\"_index\":17,\"name\":{\"22\":{}},\"comment\":{}}],[\"embeddedlinuxpipelinestack\",{\"_index\":22,\"name\":{\"28\":{}},\"comment\":{}}],[\"fedora37\",{\"_index\":12,\"name\":{\"14\":{}},\"comment\":{}}],[\"imagekind\",{\"_index\":10,\"name\":{\"12\":{},\"17\":{}},\"comment\":{}}],[\"imagerepo\",{\"_index\":18,\"name\":{\"23\":{}},\"comment\":{}}],[\"imagetag\",{\"_index\":19,\"name\":{\"24\":{}},\"comment\":{}}],[\"kas\",{\"_index\":32,\"name\":{\"40\":{}},\"comment\":{}}],[\"kind\",{\"_index\":37,\"name\":{\"45\":{}},\"comment\":{}}],[\"layerreponame\",{\"_index\":21,\"name\":{\"27\":{}},\"comment\":{}}],[\"metaawsdemo\",{\"_index\":30,\"name\":{\"38\":{}},\"comment\":{}}],[\"nxpimx\",{\"_index\":34,\"name\":{\"42\":{}},\"comment\":{}}],[\"pipelinenetworkstack\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"poky\",{\"_index\":29,\"name\":{\"37\":{}},\"comment\":{}}],[\"pokyami\",{\"_index\":31,\"name\":{\"39\":{}},\"comment\":{}}],[\"projectkind\",{\"_index\":20,\"name\":{\"26\":{},\"36\":{}},\"comment\":{}}],[\"renesas\",{\"_index\":33,\"name\":{\"41\":{}},\"comment\":{}}],[\"repo\",{\"_index\":39,\"name\":{\"48\":{}},\"comment\":{}}],[\"reponame\",{\"_index\":36,\"name\":{\"44\":{}},\"comment\":{}}],[\"repository\",{\"_index\":9,\"name\":{\"11\":{},\"19\":{}},\"comment\":{}}],[\"sourcerepo\",{\"_index\":38,\"name\":{\"46\":{}},\"comment\":{}}],[\"sourcerepoprops\",{\"_index\":35,\"name\":{\"43\":{}},\"comment\":{}}],[\"ubuntu22_04\",{\"_index\":11,\"name\":{\"13\":{}},\"comment\":{}}],[\"vpc\",{\"_index\":2,\"name\":{\"2\":{},\"25\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = JSON.parse("{\"rows\":[{\"kind\":128,\"name\":\"PipelineNetworkStack\",\"url\":\"classes/PipelineNetworkStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/PipelineNetworkStack.html#constructor\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"classes/PipelineNetworkStack.html#vpc\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":256,\"name\":\"BuildImageDataProps\",\"url\":\"interfaces/BuildImageDataProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"bucketName\",\"url\":\"interfaces/BuildImageDataProps.html#bucketName\",\"classes\":\"\",\"parent\":\"BuildImageDataProps\"},{\"kind\":128,\"name\":\"BuildImageDataStack\",\"url\":\"classes/BuildImageDataStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageDataStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":1024,\"name\":\"bucket\",\"url\":\"classes/BuildImageDataStack.html#bucket\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":2048,\"name\":\"createDeploymentBucket\",\"url\":\"classes/BuildImageDataStack.html#createDeploymentBucket\",\"classes\":\"tsd-is-private\",\"parent\":\"BuildImageDataStack\"},{\"kind\":128,\"name\":\"BuildImageRepoStack\",\"url\":\"classes/BuildImageRepoStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageRepoStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"classes/BuildImageRepoStack.html#repository\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":8,\"name\":\"ImageKind\",\"url\":\"enums/ImageKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Ubuntu22_04\",\"url\":\"enums/ImageKind.html#Ubuntu22_04\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":256,\"name\":\"BuildImagePipelineProps\",\"url\":\"interfaces/BuildImagePipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageKind\",\"url\":\"interfaces/BuildImagePipelineProps.html#imageKind\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"dataBucket\",\"url\":\"interfaces/BuildImagePipelineProps.html#dataBucket\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"interfaces/BuildImagePipelineProps.html#repository\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":128,\"name\":\"BuildImagePipelineStack\",\"url\":\"classes/BuildImagePipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImagePipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImagePipelineStack\"},{\"kind\":256,\"name\":\"EmbeddedLinuxPipelineProps\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageRepo\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#imageRepo\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"imageTag\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#imageTag\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#vpc\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"projectKind\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#projectKind\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"layerRepoName\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#layerRepoName\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":128,\"name\":\"EmbeddedLinuxPipelineStack\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addFileSystem\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addFileSystem\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addVMExportPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addVMExportPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIS3BackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIS3BackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEBSBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIEBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEC2EBSBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIEC2EBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":8,\"name\":\"ProjectKind\",\"url\":\"enums/ProjectKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Poky\",\"url\":\"enums/ProjectKind.html#Poky\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"MetaAwsDemo\",\"url\":\"enums/ProjectKind.html#MetaAwsDemo\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"PokyAmi\",\"url\":\"enums/ProjectKind.html#PokyAmi\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Kas\",\"url\":\"enums/ProjectKind.html#Kas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Renesas\",\"url\":\"enums/ProjectKind.html#Renesas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"NxpImx\",\"url\":\"enums/ProjectKind.html#NxpImx\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":256,\"name\":\"SourceRepoProps\",\"url\":\"interfaces/SourceRepoProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"repoName\",\"url\":\"interfaces/SourceRepoProps.html#repoName\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":1024,\"name\":\"kind\",\"url\":\"interfaces/SourceRepoProps.html#kind\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":128,\"name\":\"SourceRepo\",\"url\":\"classes/SourceRepo.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/SourceRepo.html#constructor\",\"classes\":\"\",\"parent\":\"SourceRepo\"},{\"kind\":1024,\"name\":\"repo\",\"url\":\"classes/SourceRepo.html#repo\",\"classes\":\"\",\"parent\":\"SourceRepo\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,34.657]],[\"comment/0\",[]],[\"name/1\",[1,19.994]],[\"comment/1\",[]],[\"name/2\",[2,29.549]],[\"comment/2\",[]],[\"name/3\",[3,34.657]],[\"comment/3\",[]],[\"name/4\",[4,34.657]],[\"comment/4\",[]],[\"name/5\",[5,34.657]],[\"comment/5\",[]],[\"name/6\",[1,19.994]],[\"comment/6\",[]],[\"name/7\",[6,34.657]],[\"comment/7\",[]],[\"name/8\",[7,34.657]],[\"comment/8\",[]],[\"name/9\",[8,34.657]],[\"comment/9\",[]],[\"name/10\",[1,19.994]],[\"comment/10\",[]],[\"name/11\",[9,29.549]],[\"comment/11\",[]],[\"name/12\",[10,29.549]],[\"comment/12\",[]],[\"name/13\",[11,34.657]],[\"comment/13\",[]],[\"name/14\",[12,34.657]],[\"comment/14\",[]],[\"name/15\",[10,29.549]],[\"comment/15\",[]],[\"name/16\",[13,34.657]],[\"comment/16\",[]],[\"name/17\",[9,29.549]],[\"comment/17\",[]],[\"name/18\",[14,34.657]],[\"comment/18\",[]],[\"name/19\",[1,19.994]],[\"comment/19\",[]],[\"name/20\",[15,34.657]],[\"comment/20\",[]],[\"name/21\",[16,34.657]],[\"comment/21\",[]],[\"name/22\",[17,34.657]],[\"comment/22\",[]],[\"name/23\",[2,29.549]],[\"comment/23\",[]],[\"name/24\",[18,29.549]],[\"comment/24\",[]],[\"name/25\",[19,34.657]],[\"comment/25\",[]],[\"name/26\",[20,34.657]],[\"comment/26\",[]],[\"name/27\",[1,19.994]],[\"comment/27\",[]],[\"name/28\",[21,34.657]],[\"comment/28\",[]],[\"name/29\",[22,34.657]],[\"comment/29\",[]],[\"name/30\",[23,34.657]],[\"comment/30\",[]],[\"name/31\",[24,34.657]],[\"comment/31\",[]],[\"name/32\",[25,34.657]],[\"comment/32\",[]],[\"name/33\",[26,34.657]],[\"comment/33\",[]],[\"name/34\",[18,29.549]],[\"comment/34\",[]],[\"name/35\",[27,34.657]],[\"comment/35\",[]],[\"name/36\",[28,34.657]],[\"comment/36\",[]],[\"name/37\",[29,34.657]],[\"comment/37\",[]],[\"name/38\",[30,34.657]],[\"comment/38\",[]],[\"name/39\",[31,34.657]],[\"comment/39\",[]],[\"name/40\",[32,34.657]],[\"comment/40\",[]],[\"name/41\",[33,34.657]],[\"comment/41\",[]],[\"name/42\",[34,34.657]],[\"comment/42\",[]],[\"name/43\",[35,34.657]],[\"comment/43\",[]],[\"name/44\",[36,34.657]],[\"comment/44\",[]],[\"name/45\",[1,19.994]],[\"comment/45\",[]],[\"name/46\",[37,34.657]],[\"comment/46\",[]]],\"invertedIndex\":[[\"addamibackuppolicy\",{\"_index\":25,\"name\":{\"32\":{}},\"comment\":{}}],[\"addamiebsbackuppolicy\",{\"_index\":24,\"name\":{\"31\":{}},\"comment\":{}}],[\"addamiec2ebsbackuppolicy\",{\"_index\":26,\"name\":{\"33\":{}},\"comment\":{}}],[\"addamis3backuppolicy\",{\"_index\":23,\"name\":{\"30\":{}},\"comment\":{}}],[\"addfilesystem\",{\"_index\":21,\"name\":{\"28\":{}},\"comment\":{}}],[\"addvmexportpolicy\",{\"_index\":22,\"name\":{\"29\":{}},\"comment\":{}}],[\"bucket\",{\"_index\":6,\"name\":{\"7\":{}},\"comment\":{}}],[\"bucketname\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"buildimagedataprops\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"buildimagedatastack\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"buildimagepipelineprops\",{\"_index\":12,\"name\":{\"14\":{}},\"comment\":{}}],[\"buildimagepipelinestack\",{\"_index\":14,\"name\":{\"18\":{}},\"comment\":{}}],[\"buildimagerepostack\",{\"_index\":8,\"name\":{\"9\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{},\"6\":{},\"10\":{},\"19\":{},\"27\":{},\"45\":{}},\"comment\":{}}],[\"createdeploymentbucket\",{\"_index\":7,\"name\":{\"8\":{}},\"comment\":{}}],[\"databucket\",{\"_index\":13,\"name\":{\"16\":{}},\"comment\":{}}],[\"embeddedlinuxpipelineprops\",{\"_index\":15,\"name\":{\"20\":{}},\"comment\":{}}],[\"embeddedlinuxpipelinestack\",{\"_index\":20,\"name\":{\"26\":{}},\"comment\":{}}],[\"imagekind\",{\"_index\":10,\"name\":{\"12\":{},\"15\":{}},\"comment\":{}}],[\"imagerepo\",{\"_index\":16,\"name\":{\"21\":{}},\"comment\":{}}],[\"imagetag\",{\"_index\":17,\"name\":{\"22\":{}},\"comment\":{}}],[\"kas\",{\"_index\":30,\"name\":{\"38\":{}},\"comment\":{}}],[\"kind\",{\"_index\":35,\"name\":{\"43\":{}},\"comment\":{}}],[\"layerreponame\",{\"_index\":19,\"name\":{\"25\":{}},\"comment\":{}}],[\"metaawsdemo\",{\"_index\":28,\"name\":{\"36\":{}},\"comment\":{}}],[\"nxpimx\",{\"_index\":32,\"name\":{\"40\":{}},\"comment\":{}}],[\"pipelinenetworkstack\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"poky\",{\"_index\":27,\"name\":{\"35\":{}},\"comment\":{}}],[\"pokyami\",{\"_index\":29,\"name\":{\"37\":{}},\"comment\":{}}],[\"projectkind\",{\"_index\":18,\"name\":{\"24\":{},\"34\":{}},\"comment\":{}}],[\"renesas\",{\"_index\":31,\"name\":{\"39\":{}},\"comment\":{}}],[\"repo\",{\"_index\":37,\"name\":{\"46\":{}},\"comment\":{}}],[\"reponame\",{\"_index\":34,\"name\":{\"42\":{}},\"comment\":{}}],[\"repository\",{\"_index\":9,\"name\":{\"11\":{},\"17\":{}},\"comment\":{}}],[\"sourcerepo\",{\"_index\":36,\"name\":{\"44\":{}},\"comment\":{}}],[\"sourcerepoprops\",{\"_index\":33,\"name\":{\"41\":{}},\"comment\":{}}],[\"ubuntu22_04\",{\"_index\":11,\"name\":{\"13\":{}},\"comment\":{}}],[\"vpc\",{\"_index\":2,\"name\":{\"2\":{},\"23\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html index 5317938..f898ce5 100644 --- a/classes/BuildImageDataStack.html +++ b/classes/BuildImageDataStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:22
    • @@ -116,7 +116,7 @@
    props: Returns BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:26

    • Properties

    @@ -179,7 +179,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:24

    • Readonly environment

    environment: string
    @@ -720,7 +720,7 @@
    bucketName: Returns IBucket
    +
  • Defined in lib/build-image-data.ts:38

    • exportStringListValue

      diff --git a/classes/BuildImagePipelineStack.html b/classes/BuildImagePipelineStack.html index cbdfd74..29431ac 100644 --- a/classes/BuildImagePipelineStack.html +++ b/classes/BuildImagePipelineStack.html @@ -27,7 +27,7 @@

      Hierarchy

      • BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:38
    • @@ -115,7 +115,7 @@
    props: Returns BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:39

    • Properties

    diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html index 3b49cc1..9cf78c9 100644 --- a/classes/BuildImageRepoStack.html +++ b/classes/BuildImageRepoStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:8
    • @@ -115,7 +115,7 @@
    Optional Returns BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:12

    • Properties

    @@ -239,7 +239,7 @@

    Readonly

    +
  • Defined in lib/build-image-repo.ts:10

    • Readonly synthesizer

    synthesizer: IStackSynthesizer
    diff --git a/classes/EmbeddedLinuxPipelineStack.html b/classes/EmbeddedLinuxPipelineStack.html index 0115b80..8cc8570 100644 --- a/classes/EmbeddedLinuxPipelineStack.html +++ b/classes/EmbeddedLinuxPipelineStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:56
    • @@ -120,7 +120,7 @@
    props: Returns EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:57

    • Properties

    @@ -585,7 +585,7 @@

    Private

  • Returns PolicyStatement

    • +
  • Defined in lib/embedded-linux-pipeline.ts:393

    • Private addAMIEBSBackupPolicy

      @@ -598,7 +598,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:380

    • Private addAMIEC2EBSBackupPolicy

      @@ -611,7 +611,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:400

    • Private addAMIS3BackupPolicy

      @@ -624,7 +624,7 @@

      Parameters

      artifactBucketArn: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:368

    • addDependency

      @@ -675,7 +675,7 @@

      Returns string

    +
  • Defined in lib/embedded-linux-pipeline.ts:336

    • addMetadata

    +
  • Defined in lib/embedded-linux-pipeline.ts:353

    • Protected allocateLogicalId

      diff --git a/classes/PipelineNetworkStack.html b/classes/PipelineNetworkStack.html index 6cd0550..0df86a3 100644 --- a/classes/PipelineNetworkStack.html +++ b/classes/PipelineNetworkStack.html @@ -26,7 +26,7 @@

      Hierarchy

      • PipelineNetworkStack
    +
  • Defined in lib/network.ts:9
    • @@ -113,7 +113,7 @@
    Optional Returns PipelineNetworkStack
    +
  • Defined in lib/network.ts:13

    • Properties

    @@ -284,7 +284,7 @@

    Readonly

    +
  • Defined in lib/network.ts:11

    • Accessors

    diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html index a54335c..b3fc4b6 100644 --- a/classes/SourceRepo.html +++ b/classes/SourceRepo.html @@ -26,7 +26,7 @@

    Hierarchy

    • SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:35
    • @@ -65,7 +65,7 @@
    props: Returns SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:39

    • Properties

    @@ -84,7 +84,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:37

    • Methods

    diff --git a/enums/ImageKind.html b/enums/ImageKind.html index cbd62ff..01717ce 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -20,7 +20,7 @@

    Enumeration ImageKind

    +
  • Defined in lib/build-image-pipeline.ts:17
    • @@ -28,36 +28,18 @@

    Enumeration Members

    -
    -

    Debian11

    -
    Debian11: "debian_11"
    -

    Debian GNU/Linux 11.x (Bullseye)

    -
    -
    -
    -

    Fedora37

    -
    Fedora37: "fedora_37"
    -

    Fedora 37

    -
    -
    -

    Ubuntu22_04

    +

    Ubuntu22_04

    Ubuntu22_04: "ubuntu_22_04"

    Ubuntu 22.04 (LTS)

    +
  • Defined in lib/build-image-pipeline.ts:19
    • @@ -77,8 +59,6 @@

    Theme

    +
  • Kas
    • +
  • Renesas
    • +
  • NxpImx
    • -
    +
  • EmbeddedLinuxPipelineStack
    • +
  • PipelineNetworkStack

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/index.html b/index.html index 394ee0d..9b42d65 100644 --- a/index.html +++ b/index.html @@ -12,30 +12,58 @@

    aws4embeddedlinux-cdk-lib

    -
    -
    -

    Index

    -
    -

    Enumerations

    -
    ImageKind -ProjectKind -
    -
    -

    Classes

    -
    BuildImageDataStack -BuildImagePipelineStack -BuildImageRepoStack -EmbeddedLinuxPipelineStack -PipelineNetworkStack -SourceRepo -
    -
    -

    Interfaces

    -
    BuildImageDataProps -BuildImagePipelineProps -EmbeddedLinuxPipelineProps -SourceRepoProps -
    +

    aws4embeddedlinux-ci

    This cdk IaC library helps you to deploy AWS cloud infrastructure to allow embedded Linux builds for your project.

    +

    Architecture

    architecture overview

    +

    API documentation

    API documentation generated by npm run doc

    +

    Setting Up

    Quickstart

    Use the examples in our examples repo.

    +

    Setting Up A New Project

      +
    1. Create a CDK project. More details can be found in the CDK Getting Started Documentation.
      mkdir my-project
      cd my-project
      cdk init app --language typescript
+
      +
      2. +
    2. Add the cdk library with npm install aws4embeddedlinux/aws4embeddedlinux-ci.
      3. +
    3. Create your application using the library. Refer to the API Documentation +and the Examples for more details.
      4. +
    4. Deploy your application using cdk deploy.
      5. +
    5. After the application is deployed, the 'Build Image' Pipeline needs to be run. This will create an Ubuntu based container for +building Yocto. This container is used by the other pipelines. If the other pipelines are run before this container is created +and pushed to ECR, they will fail. This Build Image Pipeline will run weekly by default to keep +this container patched.
      6. +
    6. Now the application pipeline can be run. This will push the contents of the Yocto deploy directory into S3.
      7. +
    +

    Development Setup

    You can use npm link to develop with a local copy of this repo.

    +

    In this library repo:

    npm install
    npm link
+
    +

    In your-project folder:

    npm install
    npm link ../aws4embeddedlinux-ci
+
    +

    This will link through the system node_modules install. When using a system node install on Linux, this can require sudo access. To avoid this, use +a node version manager +or set a node prefix.

    +

    Known issues

      +
    • Windows is currently not supported
      • +
    +

    Security

    See SECURITY for more information about reporting issues with this project.

    +

    Git Credentials and Build Time Secrets

    AWS Secrets Manager is the preferred method of adding secrets +to your pipeline. This service provides a structured means of access and avoids the pitfalls of putting secrets in environment variables, +source repos, etc.

    +
      +
    1. Create a Secret in Secrets Manager and add your secret value.
      2. +
    2. Grant access permissions to the CodeBuild pipeline project.
        +
      1. Find the IAM role for the CodeBuild Project in the CodeBuild console page under the "Build Details". This is also called the "Service Role".
        2. +
      2. In the IAM console page, add a new policy, replacing <Secret ARN> with the ARN of the secret created.
        {
            "Version": "2012-10-17",
            "Statement": [ {
                "Effect": "Allow",
                "Action": "secretsmanager:GetSecretValue",
                "Resource": "<Secret ARN>"
            } ]
        }
+
        +
        3. +
      +
      3. +
    +

    The secret can then be used in the CodeBuild Project by adding it to the BuildSpec. See +the CodeBuild Documentation for more details.

    +
    env:
        secrets-manager:
            SECRET_VALUE: "<Secret ARN>"
+
    +

    CVE Checking With Yocto

    CVE checking is enabled in the reference implementations. Details on this can be found in +the yocto documentation.

    +

    Contributing

    See CONTRIBUTING for more information.

    +

    License

    This library is licensed under the MIT-0 License. See the LICENSE file.

    +
    @@ -50,22 +78,51 @@

    Member Visibility

    • -

    Theme

    +

    Theme

    +
    +

    On This Page

     +
    +
    -
    +
  • EmbeddedLinuxPipelineStack
    • +
  • PipelineNetworkStack

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html index 8c9fc49..92da540 100644 --- a/interfaces/BuildImageDataProps.html +++ b/interfaces/BuildImageDataProps.html @@ -12,11 +12,11 @@

    Interface BuildImageDataProps

    -

    Select options for the BuildImageDataStack.

    +

    Select options for the BuildImageDataStack.

    @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataProps
    +
  • Defined in lib/build-image-data.ts:14
    • @@ -34,62 +34,35 @@

    Properties

    -
    -

    Optional Readonly analyticsReporting

    -
    analyticsReporting?: boolean
    -

    Include runtime versioning information in this Stack

    -
    -
    -

    Default

    analyticsReporting setting of containing App, or value of -'aws:cdk:version-reporting' context key

    -
    -

    Readonly bucketName

    +

    Readonly bucketName

    bucketName: string

    The bucket name for image build sources. This must be globally unique.

    -
    -

    Optional Readonly crossRegionReferences

    -
    crossRegionReferences?: boolean
    -

    Enable this flag to allow native cross region stack references.

    -

    Enabling this will create a CloudFormation custom resource -in both the producing stack and consuming stack in order to perform the export/import

    -

    This feature is currently experimental

    -
    -
    -

    Default

    false
-
    -
    +
  • Defined in lib/build-image-data.ts:16

    • Optional Readonly description

    description?: string

    A description of the stack.

    -

    Default

    - No description.
+
    Default
    - No description.
    -
    -

    Optional Readonly permissionsBoundary

    -
    permissionsBoundary?: PermissionsBoundary
    -

    Options for applying a permissions boundary to all IAM Roles -and Users created within this Stage

    -
    -
    -

    Default

    - no permissions boundary is applied
-
    -

    Optional Readonly stackName

    stackName?: string

    Name to deploy the stack with

    -

    Default

    - Derived from construct path.
+
    Default
    - Derived from construct path.
    -
    -

    Optional Readonly suppressTemplateIndentation

    -
    suppressTemplateIndentation?: boolean
    -

    Enable this flag to suppress indentation in generated -CloudFormation templates.

    -

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation -context key will be used. If that is not specified, then the -default value false will be used.

    +
    +

    Optional Readonly tags

    +
    tags?: {
        [key: string]: string;
    }
    +

    Stack tags that will be applied to all the taggable resources and the stack itself.

    +
    +

    Type declaration

    +
      +
    • +
      [key: string]: string
    -

    Default

      -
    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
      • -
    +

    Default

    {}
+
    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:94

    • Optional Readonly synthesizer

    synthesizer?: IStackSynthesizer
    @@ -191,35 +151,75 @@

    Default

      Inherited from cdk.StackProps.synthesizer

      • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:112
    -
    -

    Optional Readonly tags

    -
    tags?: {
        [key: string]: string;
    }
    -

    Stack tags that will be applied to all the taggable resources and the stack itself.

    -
    -
    -

    Type declaration

    -
      -
    • -
      [key: string]: string
    -
    -

    Default

    {}
-
    -

    Optional Readonly terminationProtection

    terminationProtection?: boolean

    Whether to enable termination protection for this stack.

    -

    Default

    false
+
    Default
    false
    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:118
    • +
    +

    Optional Readonly analyticsReporting

    +
    analyticsReporting?: boolean
    +

    Include runtime versioning information in this Stack

    +
    +
    +

    Default

    analyticsReporting setting of containing App, or value of +'aws:cdk:version-reporting' context key

    +
    +
    +

    Optional Readonly crossRegionReferences

    +
    crossRegionReferences?: boolean
    +

    Enable this flag to allow native cross region stack references.

    +

    Enabling this will create a CloudFormation custom resource +in both the producing stack and consuming stack in order to perform the export/import

    +

    This feature is currently experimental

    +
    +
    +

    Default

    false
+
    +
    +
    +

    Optional Readonly permissionsBoundary

    +
    permissionsBoundary?: PermissionsBoundary
    +

    Options for applying a permissions boundary to all IAM Roles +and Users created within this Stage

    +
    +
    +

    Default

    - no permissions boundary is applied
+
    +
    +
    +

    Optional Readonly suppressTemplateIndentation

    +
    suppressTemplateIndentation?: boolean
    +

    Enable this flag to suppress indentation in generated +CloudFormation templates.

    +

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation +context key will be used. If that is not specified, then the +default value false will be used.

    +
    +
    +

    Default

      +
    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
      • +
    +
    @@ -239,32 +239,32 @@

    Theme

    +
  • synthesizer
    • +
  • terminationProtection
    • +
  • analyticsReporting
    • +
  • crossRegionReferences
    • +
  • permissionsBoundary
    • +
  • suppressTemplateIndentation
    • -
    +
  • EmbeddedLinuxPipelineStack
    • +
  • PipelineNetworkStack

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/EmbeddedLinuxPipelineProps.html b/interfaces/EmbeddedLinuxPipelineProps.html index 4ba8869..9ac6d45 100644 --- a/interfaces/EmbeddedLinuxPipelineProps.html +++ b/interfaces/EmbeddedLinuxPipelineProps.html @@ -12,7 +12,7 @@

    Interface EmbeddedLinuxPipelineProps

    @@ -26,7 +26,7 @@

    Hierarchy

    • EmbeddedLinuxPipelineProps
    +
  • Defined in lib/embedded-linux-pipeline.ts:40
    • @@ -34,58 +34,71 @@

    Properties

    -
    -

    Optional Readonly analyticsReporting

    -
    analyticsReporting?: boolean
    -

    Include runtime versioning information in this Stack

    +
    +

    Readonly imageRepo

    +
    imageRepo: IRepository
    +

    ECR Repository where the Build Host Image resides.

    -
    -

    Default

    analyticsReporting setting of containing App, or value of -'aws:cdk:version-reporting' context key

    -
    -
    -

    Optional Readonly crossRegionReferences

    -
    crossRegionReferences?: boolean
    -

    Enable this flag to allow native cross region stack references.

    -

    Enabling this will create a CloudFormation custom resource -in both the producing stack and consuming stack in order to perform the export/import

    -

    This feature is currently experimental

    +
  • Defined in lib/embedded-linux-pipeline.ts:42
    • +
    +

    Optional Readonly imageTag

    +
    imageTag?: string
    +

    Tag for the Build Host Image

    -
    -

    Default

    false
-
    -
    +
  • Defined in lib/embedded-linux-pipeline.ts:44
    • +
    +

    Readonly vpc

    +
    vpc: IVpc
    +

    VPC where the networking setup resides.

    +
    +
    +
    +

    Optional Readonly projectKind

    +
    projectKind?: ProjectKind
    +

    The type of project being built.

    +
    +
    +
    +

    Optional Readonly layerRepoName

    +
    layerRepoName?: string
    +

    A name for the layer-repo that is created. Default is 'layer-repo'

    +
    +

    Optional Readonly description

    description?: string

    A description of the stack.

    -

    Default

    - No description.
+
    Default
    - No description.
    -
    -

    Readonly imageRepo

    -
    imageRepo: IRepository
    -

    ECR Repository where the Build Host Image resides.

    -
    -
    -
    -

    Optional Readonly imageTag

    -
    imageTag?: string
    -

    Tag for the Build Host Image

    -
    -
    -
    -

    Optional Readonly layerRepoName

    -
    layerRepoName?: string
    -

    A name for the layer-repo that is created. Default is 'layer-repo'

    -
    -
    -
    -

    Optional Readonly permissionsBoundary

    -
    permissionsBoundary?: PermissionsBoundary
    -

    Options for applying a permissions boundary to all IAM Roles -and Users created within this Stage

    -
    -
    -

    Default

    - no permissions boundary is applied
-
    -
    -
    -

    Optional Readonly projectKind

    -
    projectKind?: ProjectKind
    -

    The type of project being built.

    -
    -

    Optional Readonly stackName

    stackName?: string

    Name to deploy the stack with

    -

    Default

    - Derived from construct path.
+
    Default
    - Derived from construct path.
    -
    -

    Optional Readonly suppressTemplateIndentation

    -
    suppressTemplateIndentation?: boolean
    -

    Enable this flag to suppress indentation in generated -CloudFormation templates.

    -

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation -context key will be used. If that is not specified, then the -default value false will be used.

    +
    +

    Optional Readonly tags

    +
    tags?: {
        [key: string]: string;
    }
    +

    Stack tags that will be applied to all the taggable resources and the stack itself.

    +
    +

    Type declaration

    +
      +
    • +
      [key: string]: string
    -

    Default

      -
    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
      • -
    +

    Default

    {}
+
    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:94

    • Optional Readonly synthesizer

    synthesizer?: IStackSynthesizer
    @@ -219,43 +187,75 @@

    Default

      Inherited from cdk.StackProps.synthesizer

      • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:112
    -
    -

    Optional Readonly tags

    -
    tags?: {
        [key: string]: string;
    }
    -

    Stack tags that will be applied to all the taggable resources and the stack itself.

    -
    -
    -

    Type declaration

    -
      -
    • -
      [key: string]: string
    -
    -

    Default

    {}
-
    -

    Optional Readonly terminationProtection

    terminationProtection?: boolean

    Whether to enable termination protection for this stack.

    -

    Default

    false
+
    Default
    false
    -
    -

    Readonly vpc

    -
    vpc: IVpc
    -

    VPC where the networking setup resides.

    +
    +

    Optional Readonly analyticsReporting

    +
    analyticsReporting?: boolean
    +

    Include runtime versioning information in this Stack

    -
    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:125
    • +
    +

    Optional Readonly crossRegionReferences

    +
    crossRegionReferences?: boolean
    +

    Enable this flag to allow native cross region stack references.

    +

    Enabling this will create a CloudFormation custom resource +in both the producing stack and consuming stack in order to perform the export/import

    +

    This feature is currently experimental

    +
    +
    +

    Default

    false
+
    +
    +
    +

    Optional Readonly permissionsBoundary

    +
    permissionsBoundary?: PermissionsBoundary
    +

    Options for applying a permissions boundary to all IAM Roles +and Users created within this Stage

    +
    +
    +

    Default

    - no permissions boundary is applied
+
    +
    +
    +

    Optional Readonly suppressTemplateIndentation

    +
    suppressTemplateIndentation?: boolean
    +

    Enable this flag to suppress indentation in generated +CloudFormation templates.

    +

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation +context key will be used. If that is not specified, then the +default value false will be used.

    +
    +
    +

    Default

      +
    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
      • +
    +
    @@ -275,36 +275,36 @@

    Theme

    +
  • synthesizer
    • +
  • terminationProtection
    • +
  • analyticsReporting
    • +
  • crossRegionReferences
    • +
  • permissionsBoundary
    • +
  • suppressTemplateIndentation
    • -
    +
  • EmbeddedLinuxPipelineStack
    • +
  • PipelineNetworkStack

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/modules.html b/modules.html new file mode 100644 index 0000000..d9274a3 --- /dev/null +++ b/modules.html @@ -0,0 +1,71 @@ +aws4embeddedlinux-cdk-lib
    +
    + +
    +
    +
    +
    +

    aws4embeddedlinux-cdk-lib

    +
    +
    +

    Index

    +
    +

    Enumerations

    +
    ImageKind +ProjectKind +
    +
    +

    Classes

    +
    BuildImageDataStack +BuildImagePipelineStack +BuildImageRepoStack +SourceRepo +EmbeddedLinuxPipelineStack +PipelineNetworkStack +
    +
    +

    Interfaces

    +
    BuildImageDataProps +BuildImagePipelineProps +SourceRepoProps +EmbeddedLinuxPipelineProps +
    +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    +
    +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file From 2d36779693cef15a5b96114337b04e2b7204b90a Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Wed, 22 Nov 2023 16:00:57 +0000 Subject: [PATCH 09/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@c58bfb3de24e18d5aa29629ebd?= =?UTF-8?q?05b43b2baf807c=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/BuildImageDataStack.html | 8 ++++---- classes/BuildImagePipelineStack.html | 4 ++-- classes/BuildImageRepoStack.html | 6 +++--- classes/EmbeddedLinuxPipelineStack.html | 16 ++++++++-------- classes/PipelineNetworkStack.html | 6 +++--- classes/SourceRepo.html | 6 +++--- enums/ImageKind.html | 4 ++-- enums/ProjectKind.html | 14 +++++++------- index.html | 4 +++- interfaces/BuildImageDataProps.html | 4 ++-- interfaces/BuildImagePipelineProps.html | 8 ++++---- interfaces/EmbeddedLinuxPipelineProps.html | 12 ++++++------ interfaces/SourceRepoProps.html | 6 +++--- 13 files changed, 50 insertions(+), 48 deletions(-) diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html index ed7c1bb..cd1932b 100644 --- a/classes/BuildImageDataStack.html +++ b/classes/BuildImageDataStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:22
    • @@ -116,7 +116,7 @@
    props: Returns BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:26

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:24

    • Readonly tags

    tags: TagManager
    @@ -486,7 +486,7 @@
    bucketName: Returns IBucket
    +
  • Defined in lib/build-image-data.ts:38

    • Static isStack

      diff --git a/classes/BuildImagePipelineStack.html b/classes/BuildImagePipelineStack.html index 12730ad..7fcd2d2 100644 --- a/classes/BuildImagePipelineStack.html +++ b/classes/BuildImagePipelineStack.html @@ -28,7 +28,7 @@

      Hierarchy

      • BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:40
    • @@ -116,7 +116,7 @@
    props: Returns BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:41

    • Properties

    diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html index e30c6ae..20cdb35 100644 --- a/classes/BuildImageRepoStack.html +++ b/classes/BuildImageRepoStack.html @@ -27,7 +27,7 @@

    Hierarchy

    • BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:10
    • @@ -116,7 +116,7 @@
    Optional Returns BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:14

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-repo.ts:12

    • Readonly tags

    tags: TagManager
    diff --git a/classes/EmbeddedLinuxPipelineStack.html b/classes/EmbeddedLinuxPipelineStack.html index a1ea5c6..7dd9626 100644 --- a/classes/EmbeddedLinuxPipelineStack.html +++ b/classes/EmbeddedLinuxPipelineStack.html @@ -27,7 +27,7 @@

    Hierarchy

    • EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:58
    • @@ -121,7 +121,7 @@
    props: Returns EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:59

    • Properties

    @@ -494,7 +494,7 @@

    Returns string

    +
  • Defined in lib/embedded-linux-pipeline.ts:338

    • Private addVMExportPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:355

    • Private addAMIS3BackupPolicy

      @@ -515,7 +515,7 @@

      Parameters

      artifactBucketArn: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:370

    • Private addAMIEBSBackupPolicy

      @@ -528,7 +528,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:382

    • Private addAMIBackupPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:395

    • Private addAMIEC2EBSBackupPolicy

      @@ -549,7 +549,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:402

    • Static isStack

      diff --git a/classes/PipelineNetworkStack.html b/classes/PipelineNetworkStack.html index 5a0f080..038a707 100644 --- a/classes/PipelineNetworkStack.html +++ b/classes/PipelineNetworkStack.html @@ -28,7 +28,7 @@

      Hierarchy

      • PipelineNetworkStack
    +
  • Defined in lib/network.ts:12
    • @@ -115,7 +115,7 @@
    Optional Returns PipelineNetworkStack
    +
  • Defined in lib/network.ts:16

    • Properties

    @@ -125,7 +125,7 @@

    Readonly

    +
  • Defined in lib/network.ts:14

    • Readonly tags

    tags: TagManager
    diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html index 6cb4d1f..0d98530 100644 --- a/classes/SourceRepo.html +++ b/classes/SourceRepo.html @@ -28,7 +28,7 @@

    Hierarchy

    • SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:38
    • @@ -67,7 +67,7 @@
    props: Returns SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:42

    • Properties

    @@ -77,7 +77,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:40

    • Readonly node

    node: Node
    diff --git a/enums/ImageKind.html b/enums/ImageKind.html index 66f12a1..2ee6491 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -20,7 +20,7 @@

    Enumeration ImageKind

    +
  • Defined in lib/build-image-pipeline.ts:17
    • @@ -39,7 +39,7 @@

    Ubuntu22_04

    +
  • Defined in lib/build-image-pipeline.ts:19
    • diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html index 533b376..dba7dd1 100644 --- a/enums/ProjectKind.html +++ b/enums/ProjectKind.html @@ -20,7 +20,7 @@

    Enumeration ProjectKind

    +
  • Defined in lib/constructs/source-repo.ts:10
    • @@ -44,7 +44,7 @@

    Poky

    +
  • Defined in lib/constructs/source-repo.ts:12

    • MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"
    @@ -52,7 +52,7 @@

    MetaAwsDemo

    +
  • Defined in lib/constructs/source-repo.ts:14

    • PokyAmi

    PokyAmi: "poky-ami"
    @@ -60,7 +60,7 @@

    PokyAmi

    +
  • Defined in lib/constructs/source-repo.ts:16

    • Kas

    Kas: "kas"
    @@ -68,7 +68,7 @@

    Kas

    +
  • Defined in lib/constructs/source-repo.ts:18

    • Renesas

    Renesas: "renesas"
    @@ -76,7 +76,7 @@

    Renesas

    +
  • Defined in lib/constructs/source-repo.ts:20

    • NxpImx

    NxpImx: "nxp-imx"
    @@ -84,7 +84,7 @@

    NxpImx

    +
  • Defined in lib/constructs/source-repo.ts:22
    • diff --git a/index.html b/index.html index 9b42d65..8d1c79b 100644 --- a/index.html +++ b/index.html @@ -31,7 +31,7 @@

    aws4embeddedlinux-cdk-lib

  • Now the application pipeline can be run. This will push the contents of the Yocto deploy directory into S3.

    • Development Setup

    You can use npm link to develop with a local copy of this repo.

    -

    In this library repo:

    npm install
    npm link
+
    In this library repo:
    npm install
 
    
 
    In your-project folder:
    npm install
    npm link ../aws4embeddedlinux-ci
 
    
@@ -40,6 +40,8 @@ 
    aws4embeddedlinux-cdk-lib
    or set a node prefix.

    Known issues

    • Windows is currently not supported
      • +
    • When using AWS Cloud9 a micro instance type will run out of memory
      • +
    • Deletion of stacks while a CodePipeline is running this can lead to unexpected failures

    Security

    See SECURITY for more information about reporting issues with this project.

    Git Credentials and Build Time Secrets

    AWS Secrets Manager is the preferred method of adding secrets diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html index 92da540..4975cf1 100644 --- a/interfaces/BuildImageDataProps.html +++ b/interfaces/BuildImageDataProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataProps
    +
  • Defined in lib/build-image-data.ts:14
    • @@ -55,7 +55,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:16

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/BuildImagePipelineProps.html b/interfaces/BuildImagePipelineProps.html index 416758e..fd28ec5 100644 --- a/interfaces/BuildImagePipelineProps.html +++ b/interfaces/BuildImagePipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImagePipelineProps
    +
  • Defined in lib/build-image-pipeline.ts:25
    • @@ -57,7 +57,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:27

    • Readonly dataBucket

    dataBucket: IBucket
    @@ -65,7 +65,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:29

    • Readonly repository

    repository: IRepository
    @@ -73,7 +73,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:31

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/EmbeddedLinuxPipelineProps.html b/interfaces/EmbeddedLinuxPipelineProps.html index 9ac6d45..a613f32 100644 --- a/interfaces/EmbeddedLinuxPipelineProps.html +++ b/interfaces/EmbeddedLinuxPipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • EmbeddedLinuxPipelineProps
    +
  • Defined in lib/embedded-linux-pipeline.ts:40
    • @@ -59,7 +59,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:42

    • Optional Readonly imageTag

    imageTag?: string
    @@ -67,7 +67,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:44

    • Readonly vpc

    vpc: IVpc
    @@ -75,7 +75,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:46

    • Optional Readonly projectKind

    projectKind?: ProjectKind
    @@ -83,7 +83,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:48

    • Optional Readonly layerRepoName

    layerRepoName?: string
    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:50

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html index f9f5991..b54cef0 100644 --- a/interfaces/SourceRepoProps.html +++ b/interfaces/SourceRepoProps.html @@ -22,7 +22,7 @@

    Hierarchy

    • SourceRepoProps
    +
  • Defined in lib/constructs/source-repo.ts:25
    • @@ -52,7 +52,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:27

    • Readonly kind

    kind: ProjectKind
    @@ -60,7 +60,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:29

    • Optional Readonly description

    description?: string
    From 72a6032a2cf2c3ac484bccfa442546b3365768d9 Mon Sep 17 00:00:00 2001 From: nateglims Date: Wed, 22 Nov 2023 23:34:43 +0000 Subject: [PATCH 10/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@af1c9e5d45e879a2f1d7537253?= =?UTF-8?q?183d35d659f924=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/BuildImageDataStack.html | 8 ++++---- classes/BuildImagePipelineStack.html | 4 ++-- classes/BuildImageRepoStack.html | 6 +++--- classes/EmbeddedLinuxPipelineStack.html | 16 ++++++++-------- classes/PipelineNetworkStack.html | 6 +++--- classes/SourceRepo.html | 6 +++--- enums/ImageKind.html | 4 ++-- enums/ProjectKind.html | 14 +++++++------- interfaces/BuildImageDataProps.html | 4 ++-- interfaces/BuildImagePipelineProps.html | 8 ++++---- interfaces/EmbeddedLinuxPipelineProps.html | 12 ++++++------ interfaces/SourceRepoProps.html | 6 +++--- 12 files changed, 47 insertions(+), 47 deletions(-) diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html index cd1932b..ac155b1 100644 --- a/classes/BuildImageDataStack.html +++ b/classes/BuildImageDataStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:22
    • @@ -116,7 +116,7 @@
    props: Returns BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:26

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:24

    • Readonly tags

    tags: TagManager
    @@ -486,7 +486,7 @@
    bucketName: Returns IBucket
    +
  • Defined in lib/build-image-data.ts:38

    • Static isStack

      diff --git a/classes/BuildImagePipelineStack.html b/classes/BuildImagePipelineStack.html index 7fcd2d2..17dfdaa 100644 --- a/classes/BuildImagePipelineStack.html +++ b/classes/BuildImagePipelineStack.html @@ -28,7 +28,7 @@

      Hierarchy

      • BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:40
    • @@ -116,7 +116,7 @@
    props: Returns BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:41

    • Properties

    diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html index 20cdb35..b908b1a 100644 --- a/classes/BuildImageRepoStack.html +++ b/classes/BuildImageRepoStack.html @@ -27,7 +27,7 @@

    Hierarchy

    • BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:10
    • @@ -116,7 +116,7 @@
    Optional Returns BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:14

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-repo.ts:12

    • Readonly tags

    tags: TagManager
    diff --git a/classes/EmbeddedLinuxPipelineStack.html b/classes/EmbeddedLinuxPipelineStack.html index 7dd9626..a83c4a4 100644 --- a/classes/EmbeddedLinuxPipelineStack.html +++ b/classes/EmbeddedLinuxPipelineStack.html @@ -27,7 +27,7 @@

    Hierarchy

    • EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:58
    • @@ -121,7 +121,7 @@
    props: Returns EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:59

    • Properties

    @@ -494,7 +494,7 @@

    Returns string

    +
  • Defined in lib/embedded-linux-pipeline.ts:338

    • Private addVMExportPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:355

    • Private addAMIS3BackupPolicy

      @@ -515,7 +515,7 @@

      Parameters

      artifactBucketArn: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:370

    • Private addAMIEBSBackupPolicy

      @@ -528,7 +528,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:382

    • Private addAMIBackupPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:395

    • Private addAMIEC2EBSBackupPolicy

      @@ -549,7 +549,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:402

    • Static isStack

      diff --git a/classes/PipelineNetworkStack.html b/classes/PipelineNetworkStack.html index 038a707..cade048 100644 --- a/classes/PipelineNetworkStack.html +++ b/classes/PipelineNetworkStack.html @@ -28,7 +28,7 @@

      Hierarchy

      • PipelineNetworkStack
    +
  • Defined in lib/network.ts:12
    • @@ -115,7 +115,7 @@
    Optional Returns PipelineNetworkStack
    +
  • Defined in lib/network.ts:16

    • Properties

    @@ -125,7 +125,7 @@

    Readonly

    +
  • Defined in lib/network.ts:14

    • Readonly tags

    tags: TagManager
    diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html index 0d98530..5adca6e 100644 --- a/classes/SourceRepo.html +++ b/classes/SourceRepo.html @@ -28,7 +28,7 @@

    Hierarchy

    • SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:38
    • @@ -67,7 +67,7 @@
    props: Returns SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:42

    • Properties

    @@ -77,7 +77,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:40

    • Readonly node

    node: Node
    diff --git a/enums/ImageKind.html b/enums/ImageKind.html index 2ee6491..558c594 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -20,7 +20,7 @@

    Enumeration ImageKind

    +
  • Defined in lib/build-image-pipeline.ts:17
    • @@ -39,7 +39,7 @@

    Ubuntu22_04

    +
  • Defined in lib/build-image-pipeline.ts:19
    • diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html index dba7dd1..2cdf1e1 100644 --- a/enums/ProjectKind.html +++ b/enums/ProjectKind.html @@ -20,7 +20,7 @@

    Enumeration ProjectKind

    +
  • Defined in lib/constructs/source-repo.ts:10
    • @@ -44,7 +44,7 @@

    Poky

    +
  • Defined in lib/constructs/source-repo.ts:12

    • MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"
    @@ -52,7 +52,7 @@

    MetaAwsDemo

    +
  • Defined in lib/constructs/source-repo.ts:14

    • PokyAmi

    PokyAmi: "poky-ami"
    @@ -60,7 +60,7 @@

    PokyAmi

    +
  • Defined in lib/constructs/source-repo.ts:16

    • Kas

    Kas: "kas"
    @@ -68,7 +68,7 @@

    Kas

    +
  • Defined in lib/constructs/source-repo.ts:18

    • Renesas

    Renesas: "renesas"
    @@ -76,7 +76,7 @@

    Renesas

    +
  • Defined in lib/constructs/source-repo.ts:20

    • NxpImx

    NxpImx: "nxp-imx"
    @@ -84,7 +84,7 @@

    NxpImx

    +
  • Defined in lib/constructs/source-repo.ts:22
    • diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html index 4975cf1..bbb9a86 100644 --- a/interfaces/BuildImageDataProps.html +++ b/interfaces/BuildImageDataProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataProps
    +
  • Defined in lib/build-image-data.ts:14
    • @@ -55,7 +55,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:16

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/BuildImagePipelineProps.html b/interfaces/BuildImagePipelineProps.html index fd28ec5..992f6a7 100644 --- a/interfaces/BuildImagePipelineProps.html +++ b/interfaces/BuildImagePipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImagePipelineProps
    +
  • Defined in lib/build-image-pipeline.ts:25
    • @@ -57,7 +57,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:27

    • Readonly dataBucket

    dataBucket: IBucket
    @@ -65,7 +65,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:29

    • Readonly repository

    repository: IRepository
    @@ -73,7 +73,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:31

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/EmbeddedLinuxPipelineProps.html b/interfaces/EmbeddedLinuxPipelineProps.html index a613f32..d1c775f 100644 --- a/interfaces/EmbeddedLinuxPipelineProps.html +++ b/interfaces/EmbeddedLinuxPipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • EmbeddedLinuxPipelineProps
    +
  • Defined in lib/embedded-linux-pipeline.ts:40
    • @@ -59,7 +59,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:42

    • Optional Readonly imageTag

    imageTag?: string
    @@ -67,7 +67,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:44

    • Readonly vpc

    vpc: IVpc
    @@ -75,7 +75,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:46

    • Optional Readonly projectKind

    projectKind?: ProjectKind
    @@ -83,7 +83,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:48

    • Optional Readonly layerRepoName

    layerRepoName?: string
    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:50

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html index b54cef0..b255702 100644 --- a/interfaces/SourceRepoProps.html +++ b/interfaces/SourceRepoProps.html @@ -22,7 +22,7 @@

    Hierarchy

    • SourceRepoProps
    +
  • Defined in lib/constructs/source-repo.ts:25
    • @@ -52,7 +52,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:27

    • Readonly kind

    kind: ProjectKind
    @@ -60,7 +60,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:29

    • Optional Readonly description

    description?: string
    From 7a1cbb36a3b90600c5337232b7e559ea27b76a3c Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Thu, 23 Nov 2023 10:36:07 +0000 Subject: [PATCH 11/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@0201170cf5cfeee84b56ca1089?= =?UTF-8?q?229b25cedcecbc=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/BuildImageDataStack.html | 8 ++++---- classes/BuildImagePipelineStack.html | 4 ++-- classes/BuildImageRepoStack.html | 6 +++--- classes/EmbeddedLinuxPipelineStack.html | 16 ++++++++-------- classes/PipelineNetworkStack.html | 6 +++--- classes/SourceRepo.html | 6 +++--- enums/ImageKind.html | 4 ++-- enums/ProjectKind.html | 14 +++++++------- index.html | 6 +++--- interfaces/BuildImageDataProps.html | 4 ++-- interfaces/BuildImagePipelineProps.html | 8 ++++---- interfaces/EmbeddedLinuxPipelineProps.html | 12 ++++++------ interfaces/SourceRepoProps.html | 6 +++--- 13 files changed, 50 insertions(+), 50 deletions(-) diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html index ac155b1..e6b512e 100644 --- a/classes/BuildImageDataStack.html +++ b/classes/BuildImageDataStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:22
    • @@ -116,7 +116,7 @@
    props: Returns BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:26

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:24

    • Readonly tags

    tags: TagManager
    @@ -486,7 +486,7 @@
    bucketName: Returns IBucket
    +
  • Defined in lib/build-image-data.ts:38

    • Static isStack

      diff --git a/classes/BuildImagePipelineStack.html b/classes/BuildImagePipelineStack.html index 17dfdaa..03b6f1d 100644 --- a/classes/BuildImagePipelineStack.html +++ b/classes/BuildImagePipelineStack.html @@ -28,7 +28,7 @@

      Hierarchy

      • BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:40
    • @@ -116,7 +116,7 @@
    props: Returns BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:41

    • Properties

    diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html index b908b1a..faae0f0 100644 --- a/classes/BuildImageRepoStack.html +++ b/classes/BuildImageRepoStack.html @@ -27,7 +27,7 @@

    Hierarchy

    • BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:10
    • @@ -116,7 +116,7 @@
    Optional Returns BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:14

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-repo.ts:12

    • Readonly tags

    tags: TagManager
    diff --git a/classes/EmbeddedLinuxPipelineStack.html b/classes/EmbeddedLinuxPipelineStack.html index a83c4a4..f83f63c 100644 --- a/classes/EmbeddedLinuxPipelineStack.html +++ b/classes/EmbeddedLinuxPipelineStack.html @@ -27,7 +27,7 @@

    Hierarchy

    • EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:58
    • @@ -121,7 +121,7 @@
    props: Returns EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:59

    • Properties

    @@ -494,7 +494,7 @@

    Returns string

    +
  • Defined in lib/embedded-linux-pipeline.ts:338

    • Private addVMExportPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:355

    • Private addAMIS3BackupPolicy

      @@ -515,7 +515,7 @@

      Parameters

      artifactBucketArn: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:370

    • Private addAMIEBSBackupPolicy

      @@ -528,7 +528,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:382

    • Private addAMIBackupPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:395

    • Private addAMIEC2EBSBackupPolicy

      @@ -549,7 +549,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:402

    • Static isStack

      diff --git a/classes/PipelineNetworkStack.html b/classes/PipelineNetworkStack.html index cade048..ae1fb59 100644 --- a/classes/PipelineNetworkStack.html +++ b/classes/PipelineNetworkStack.html @@ -28,7 +28,7 @@

      Hierarchy

      • PipelineNetworkStack
    +
  • Defined in lib/network.ts:12
    • @@ -115,7 +115,7 @@
    Optional Returns PipelineNetworkStack
    +
  • Defined in lib/network.ts:16

    • Properties

    @@ -125,7 +125,7 @@

    Readonly

    +
  • Defined in lib/network.ts:14

    • Readonly tags

    tags: TagManager
    diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html index 5adca6e..3879c92 100644 --- a/classes/SourceRepo.html +++ b/classes/SourceRepo.html @@ -28,7 +28,7 @@

    Hierarchy

    • SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:38
    • @@ -67,7 +67,7 @@
    props: Returns SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:42

    • Properties

    @@ -77,7 +77,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:40

    • Readonly node

    node: Node
    diff --git a/enums/ImageKind.html b/enums/ImageKind.html index 558c594..36ea68f 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -20,7 +20,7 @@

    Enumeration ImageKind

    +
  • Defined in lib/build-image-pipeline.ts:17
    • @@ -39,7 +39,7 @@

    Ubuntu22_04

    +
  • Defined in lib/build-image-pipeline.ts:19
    • diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html index 2cdf1e1..0fb9776 100644 --- a/enums/ProjectKind.html +++ b/enums/ProjectKind.html @@ -20,7 +20,7 @@

    Enumeration ProjectKind

    +
  • Defined in lib/constructs/source-repo.ts:10
    • @@ -44,7 +44,7 @@

    Poky

    +
  • Defined in lib/constructs/source-repo.ts:12

    • MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"
    @@ -52,7 +52,7 @@

    MetaAwsDemo

    +
  • Defined in lib/constructs/source-repo.ts:14

    • PokyAmi

    PokyAmi: "poky-ami"
    @@ -60,7 +60,7 @@

    PokyAmi

    +
  • Defined in lib/constructs/source-repo.ts:16

    • Kas

    Kas: "kas"
    @@ -68,7 +68,7 @@

    Kas

    +
  • Defined in lib/constructs/source-repo.ts:18

    • Renesas

    Renesas: "renesas"
    @@ -76,7 +76,7 @@

    Renesas

    +
  • Defined in lib/constructs/source-repo.ts:20

    • NxpImx

    NxpImx: "nxp-imx"
    @@ -84,7 +84,7 @@

    NxpImx

    +
  • Defined in lib/constructs/source-repo.ts:22
    • diff --git a/index.html b/index.html index 8d1c79b..fc3da41 100644 --- a/index.html +++ b/index.html @@ -39,9 +39,9 @@

    aws4embeddedlinux-cdk-lib

    a node version manager or set a node prefix.

    Known issues

      -
    • Windows is currently not supported
      • -
    • When using AWS Cloud9 a micro instance type will run out of memory
      • -
    • Deletion of stacks while a CodePipeline is running this can lead to unexpected failures
      • +
    • Windows is currently not supported.
      • +
    • When using AWS Cloud9 a micro instance type will run out of memory.
      • +
    • Deletion of stacks while a CodePipeline is running can lead to unexpected failures.

    Security

    See SECURITY for more information about reporting issues with this project.

    Git Credentials and Build Time Secrets

    AWS Secrets Manager is the preferred method of adding secrets diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html index bbb9a86..450f6a8 100644 --- a/interfaces/BuildImageDataProps.html +++ b/interfaces/BuildImageDataProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataProps
    +
  • Defined in lib/build-image-data.ts:14
    • @@ -55,7 +55,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:16

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/BuildImagePipelineProps.html b/interfaces/BuildImagePipelineProps.html index 992f6a7..3a9b5f3 100644 --- a/interfaces/BuildImagePipelineProps.html +++ b/interfaces/BuildImagePipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImagePipelineProps
    +
  • Defined in lib/build-image-pipeline.ts:25
    • @@ -57,7 +57,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:27

    • Readonly dataBucket

    dataBucket: IBucket
    @@ -65,7 +65,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:29

    • Readonly repository

    repository: IRepository
    @@ -73,7 +73,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:31

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/EmbeddedLinuxPipelineProps.html b/interfaces/EmbeddedLinuxPipelineProps.html index d1c775f..47a7250 100644 --- a/interfaces/EmbeddedLinuxPipelineProps.html +++ b/interfaces/EmbeddedLinuxPipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • EmbeddedLinuxPipelineProps
    +
  • Defined in lib/embedded-linux-pipeline.ts:40
    • @@ -59,7 +59,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:42

    • Optional Readonly imageTag

    imageTag?: string
    @@ -67,7 +67,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:44

    • Readonly vpc

    vpc: IVpc
    @@ -75,7 +75,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:46

    • Optional Readonly projectKind

    projectKind?: ProjectKind
    @@ -83,7 +83,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:48

    • Optional Readonly layerRepoName

    layerRepoName?: string
    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:50

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html index b255702..9dff7f0 100644 --- a/interfaces/SourceRepoProps.html +++ b/interfaces/SourceRepoProps.html @@ -22,7 +22,7 @@

    Hierarchy

    • SourceRepoProps
    +
  • Defined in lib/constructs/source-repo.ts:25
    • @@ -52,7 +52,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:27

    • Readonly kind

    kind: ProjectKind
    @@ -60,7 +60,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:29

    • Optional Readonly description

    description?: string
    From ecf194309a987621f83b098b4e3b69bae65f4ebb Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Thu, 23 Nov 2023 17:43:54 +0000 Subject: [PATCH 12/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@21e981b6b500c45f25c34cfa4e?= =?UTF-8?q?8088582a709426=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/BuildImageDataStack.html | 8 ++++---- classes/BuildImagePipelineStack.html | 4 ++-- classes/BuildImageRepoStack.html | 6 +++--- classes/EmbeddedLinuxPipelineStack.html | 16 ++++++++-------- classes/PipelineNetworkStack.html | 6 +++--- classes/SourceRepo.html | 6 +++--- enums/ImageKind.html | 4 ++-- enums/ProjectKind.html | 14 +++++++------- index.html | 9 ++++++++- interfaces/BuildImageDataProps.html | 4 ++-- interfaces/BuildImagePipelineProps.html | 8 ++++---- interfaces/EmbeddedLinuxPipelineProps.html | 12 ++++++------ interfaces/SourceRepoProps.html | 6 +++--- 13 files changed, 55 insertions(+), 48 deletions(-) diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html index e6b512e..bcad197 100644 --- a/classes/BuildImageDataStack.html +++ b/classes/BuildImageDataStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:22
    • @@ -116,7 +116,7 @@
    props: Returns BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:26

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:24

    • Readonly tags

    tags: TagManager
    @@ -486,7 +486,7 @@
    bucketName: Returns IBucket
    +
  • Defined in lib/build-image-data.ts:38

    • Static isStack

      diff --git a/classes/BuildImagePipelineStack.html b/classes/BuildImagePipelineStack.html index 03b6f1d..f89cd47 100644 --- a/classes/BuildImagePipelineStack.html +++ b/classes/BuildImagePipelineStack.html @@ -28,7 +28,7 @@

      Hierarchy

      • BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:40
    • @@ -116,7 +116,7 @@
    props: Returns BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:41

    • Properties

    diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html index faae0f0..0c89479 100644 --- a/classes/BuildImageRepoStack.html +++ b/classes/BuildImageRepoStack.html @@ -27,7 +27,7 @@

    Hierarchy

    • BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:10
    • @@ -116,7 +116,7 @@
    Optional Returns BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:14

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-repo.ts:12

    • Readonly tags

    tags: TagManager
    diff --git a/classes/EmbeddedLinuxPipelineStack.html b/classes/EmbeddedLinuxPipelineStack.html index f83f63c..83895e3 100644 --- a/classes/EmbeddedLinuxPipelineStack.html +++ b/classes/EmbeddedLinuxPipelineStack.html @@ -27,7 +27,7 @@

    Hierarchy

    • EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:58
    • @@ -121,7 +121,7 @@
    props: Returns EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:59

    • Properties

    @@ -494,7 +494,7 @@

    Returns string

    +
  • Defined in lib/embedded-linux-pipeline.ts:338

    • Private addVMExportPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:355

    • Private addAMIS3BackupPolicy

      @@ -515,7 +515,7 @@

      Parameters

      artifactBucketArn: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:370

    • Private addAMIEBSBackupPolicy

      @@ -528,7 +528,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:382

    • Private addAMIBackupPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:395

    • Private addAMIEC2EBSBackupPolicy

      @@ -549,7 +549,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:402

    • Static isStack

      diff --git a/classes/PipelineNetworkStack.html b/classes/PipelineNetworkStack.html index ae1fb59..e359162 100644 --- a/classes/PipelineNetworkStack.html +++ b/classes/PipelineNetworkStack.html @@ -28,7 +28,7 @@

      Hierarchy

      • PipelineNetworkStack
    +
  • Defined in lib/network.ts:12
    • @@ -115,7 +115,7 @@
    Optional Returns PipelineNetworkStack
    +
  • Defined in lib/network.ts:16

    • Properties

    @@ -125,7 +125,7 @@

    Readonly

    +
  • Defined in lib/network.ts:14

    • Readonly tags

    tags: TagManager
    diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html index 3879c92..6fd9442 100644 --- a/classes/SourceRepo.html +++ b/classes/SourceRepo.html @@ -28,7 +28,7 @@

    Hierarchy

    • SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:38
    • @@ -67,7 +67,7 @@
    props: Returns SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:42

    • Properties

    @@ -77,7 +77,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:40

    • Readonly node

    node: Node
    diff --git a/enums/ImageKind.html b/enums/ImageKind.html index 36ea68f..c1397df 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -20,7 +20,7 @@

    Enumeration ImageKind

    +
  • Defined in lib/build-image-pipeline.ts:17
    • @@ -39,7 +39,7 @@

    Ubuntu22_04

    +
  • Defined in lib/build-image-pipeline.ts:19
    • diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html index 0fb9776..beda325 100644 --- a/enums/ProjectKind.html +++ b/enums/ProjectKind.html @@ -20,7 +20,7 @@

    Enumeration ProjectKind

    +
  • Defined in lib/constructs/source-repo.ts:10
    • @@ -44,7 +44,7 @@

    Poky

    +
  • Defined in lib/constructs/source-repo.ts:12

    • MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"
    @@ -52,7 +52,7 @@

    MetaAwsDemo

    +
  • Defined in lib/constructs/source-repo.ts:14

    • PokyAmi

    PokyAmi: "poky-ami"
    @@ -60,7 +60,7 @@

    PokyAmi

    +
  • Defined in lib/constructs/source-repo.ts:16

    • Kas

    Kas: "kas"
    @@ -68,7 +68,7 @@

    Kas

    +
  • Defined in lib/constructs/source-repo.ts:18

    • Renesas

    Renesas: "renesas"
    @@ -76,7 +76,7 @@

    Renesas

    +
  • Defined in lib/constructs/source-repo.ts:20

    • NxpImx

    NxpImx: "nxp-imx"
    @@ -84,7 +84,7 @@

    NxpImx

    +
  • Defined in lib/constructs/source-repo.ts:22
    • diff --git a/index.html b/index.html index fc3da41..67e697c 100644 --- a/index.html +++ b/index.html @@ -15,7 +15,14 @@

    aws4embeddedlinux-cdk-lib

    aws4embeddedlinux-ci

    This cdk IaC library helps you to deploy AWS cloud infrastructure to allow embedded Linux builds for your project.

    Architecture

    architecture overview

    API documentation

    API documentation generated by npm run doc

    -

    Setting Up

    Quickstart

    Use the examples in our examples repo.

    +

    Setting Up

    In order to use this library, you must set up the CDK, including +installing the CDK tool and bootstrapping the account you wish to deploy to. Additionally, you must have Node installed.

    +
    +

    [!NOTE] +This library is tested against Node Versions 16, 18, and 20. If these versions are not available for your system, we recommend +using NVM to install a compatible version

    +
    +

    Quickstart

    Use the examples in our examples repo.

    Setting Up A New Project

    1. Create a CDK project. More details can be found in the CDK Getting Started Documentation.
      mkdir my-project
      cd my-project
      cdk init app --language typescript
      diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html index 450f6a8..599721a 100644 --- a/interfaces/BuildImageDataProps.html +++ b/interfaces/BuildImageDataProps.html @@ -26,7 +26,7 @@

      Hierarchy

      • BuildImageDataProps
      2. +
    2. Defined in lib/build-image-data.ts:14
      3. @@ -55,7 +55,7 @@

      Readonly

      +
    3. Defined in lib/build-image-data.ts:16

      4. Optional Readonly description

      description?: string
      diff --git a/interfaces/BuildImagePipelineProps.html b/interfaces/BuildImagePipelineProps.html index 3a9b5f3..f45527c 100644 --- a/interfaces/BuildImagePipelineProps.html +++ b/interfaces/BuildImagePipelineProps.html @@ -26,7 +26,7 @@

      Hierarchy

      • BuildImagePipelineProps
      +
    4. Defined in lib/build-image-pipeline.ts:25
      5. @@ -57,7 +57,7 @@

      Readonly

      +
    5. Defined in lib/build-image-pipeline.ts:27

      6. Readonly dataBucket

      dataBucket: IBucket
      @@ -65,7 +65,7 @@

      Readonly

      +
    6. Defined in lib/build-image-pipeline.ts:29

      7. Readonly repository

      repository: IRepository
      @@ -73,7 +73,7 @@

      Readonly

      +
    7. Defined in lib/build-image-pipeline.ts:31

      8. Optional Readonly description

      description?: string
      diff --git a/interfaces/EmbeddedLinuxPipelineProps.html b/interfaces/EmbeddedLinuxPipelineProps.html index 47a7250..623f671 100644 --- a/interfaces/EmbeddedLinuxPipelineProps.html +++ b/interfaces/EmbeddedLinuxPipelineProps.html @@ -26,7 +26,7 @@

      Hierarchy

      • EmbeddedLinuxPipelineProps
      +
    8. Defined in lib/embedded-linux-pipeline.ts:40
      9. @@ -59,7 +59,7 @@

      Readonly

      +
    9. Defined in lib/embedded-linux-pipeline.ts:42

      10. Optional Readonly imageTag

      imageTag?: string
      @@ -67,7 +67,7 @@

      Optional

      +
    10. Defined in lib/embedded-linux-pipeline.ts:44

      11. Readonly vpc

      vpc: IVpc
      @@ -75,7 +75,7 @@

      Readonly

      +
    11. Defined in lib/embedded-linux-pipeline.ts:46

      12. Optional Readonly projectKind

      projectKind?: ProjectKind
      @@ -83,7 +83,7 @@

      Optional

      +
    12. Defined in lib/embedded-linux-pipeline.ts:48

      13. Optional Readonly layerRepoName

      layerRepoName?: string
      @@ -91,7 +91,7 @@

      Optional

      +
    13. Defined in lib/embedded-linux-pipeline.ts:50

      14. Optional Readonly description

      description?: string
      diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html index 9dff7f0..1dd7369 100644 --- a/interfaces/SourceRepoProps.html +++ b/interfaces/SourceRepoProps.html @@ -22,7 +22,7 @@

      Hierarchy

      • SourceRepoProps
      +
    14. Defined in lib/constructs/source-repo.ts:25
      15. @@ -52,7 +52,7 @@

      Readonly

      +
    15. Defined in lib/constructs/source-repo.ts:27

      16. Readonly kind

      kind: ProjectKind
      @@ -60,7 +60,7 @@

      Readonly

      +
    16. Defined in lib/constructs/source-repo.ts:29

      17. Optional Readonly description

      description?: string
      From d5d2ac7550343ab5946930c8618e492f8a63aa04 Mon Sep 17 00:00:00 2001 From: nateglims Date: Fri, 24 Nov 2023 13:32:57 +0000 Subject: [PATCH 13/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@15aa7c5c329203bc3a10abcb81?= =?UTF-8?q?1dedb02f001790=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/BuildImageDataStack.html | 8 ++++---- classes/BuildImagePipelineStack.html | 4 ++-- classes/BuildImageRepoStack.html | 6 +++--- classes/EmbeddedLinuxPipelineStack.html | 16 ++++++++-------- classes/PipelineNetworkStack.html | 6 +++--- classes/SourceRepo.html | 6 +++--- enums/ImageKind.html | 4 ++-- enums/ProjectKind.html | 14 +++++++------- interfaces/BuildImageDataProps.html | 4 ++-- interfaces/BuildImagePipelineProps.html | 8 ++++---- interfaces/EmbeddedLinuxPipelineProps.html | 12 ++++++------ interfaces/SourceRepoProps.html | 6 +++--- 12 files changed, 47 insertions(+), 47 deletions(-) diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html index bcad197..677733e 100644 --- a/classes/BuildImageDataStack.html +++ b/classes/BuildImageDataStack.html @@ -26,7 +26,7 @@

      Hierarchy

      • BuildImageDataStack
      +
    17. Defined in lib/build-image-data.ts:22
      18. @@ -116,7 +116,7 @@
      props: Returns BuildImageDataStack
      +
    18. Defined in lib/build-image-data.ts:26

      19. Properties

      @@ -126,7 +126,7 @@

      Readonly

      +
    19. Defined in lib/build-image-data.ts:24

      20. Readonly tags

      tags: TagManager
      @@ -486,7 +486,7 @@
      bucketName: Returns IBucket
      +
    20. Defined in lib/build-image-data.ts:38

      21. Static isStack

        diff --git a/classes/BuildImagePipelineStack.html b/classes/BuildImagePipelineStack.html index f89cd47..0bae40e 100644 --- a/classes/BuildImagePipelineStack.html +++ b/classes/BuildImagePipelineStack.html @@ -28,7 +28,7 @@

        Hierarchy

        • BuildImagePipelineStack
      +
    21. Defined in lib/build-image-pipeline.ts:40
      22. @@ -116,7 +116,7 @@
      props: Returns BuildImagePipelineStack
      +
    22. Defined in lib/build-image-pipeline.ts:41

      23. Properties

      diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html index 0c89479..129bf12 100644 --- a/classes/BuildImageRepoStack.html +++ b/classes/BuildImageRepoStack.html @@ -27,7 +27,7 @@

      Hierarchy

      • BuildImageRepoStack
      +
    23. Defined in lib/build-image-repo.ts:10
      24. @@ -116,7 +116,7 @@
      Optional Returns BuildImageRepoStack
      +
    24. Defined in lib/build-image-repo.ts:14

      25. Properties

      @@ -126,7 +126,7 @@

      Readonly

      +
    25. Defined in lib/build-image-repo.ts:12

      26. Readonly tags

      tags: TagManager
      diff --git a/classes/EmbeddedLinuxPipelineStack.html b/classes/EmbeddedLinuxPipelineStack.html index 83895e3..8868b0e 100644 --- a/classes/EmbeddedLinuxPipelineStack.html +++ b/classes/EmbeddedLinuxPipelineStack.html @@ -27,7 +27,7 @@

      Hierarchy

      • EmbeddedLinuxPipelineStack
      +
    26. Defined in lib/embedded-linux-pipeline.ts:58
      27. @@ -121,7 +121,7 @@
      props: Returns EmbeddedLinuxPipelineStack
      +
    27. Defined in lib/embedded-linux-pipeline.ts:59

      28. Properties

      @@ -494,7 +494,7 @@

      Returns string

    +
  • Defined in lib/embedded-linux-pipeline.ts:338

    • Private addVMExportPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:355

    • Private addAMIS3BackupPolicy

      @@ -515,7 +515,7 @@

      Parameters

      artifactBucketArn: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:370

    • Private addAMIEBSBackupPolicy

      @@ -528,7 +528,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:382

    • Private addAMIBackupPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:395

    • Private addAMIEC2EBSBackupPolicy

      @@ -549,7 +549,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:402

    • Static isStack

      diff --git a/classes/PipelineNetworkStack.html b/classes/PipelineNetworkStack.html index e359162..57a1e35 100644 --- a/classes/PipelineNetworkStack.html +++ b/classes/PipelineNetworkStack.html @@ -28,7 +28,7 @@

      Hierarchy

      • PipelineNetworkStack
    +
  • Defined in lib/network.ts:12
    • @@ -115,7 +115,7 @@
    Optional Returns PipelineNetworkStack
    +
  • Defined in lib/network.ts:16

    • Properties

    @@ -125,7 +125,7 @@

    Readonly

    +
  • Defined in lib/network.ts:14

    • Readonly tags

    tags: TagManager
    diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html index 6fd9442..29581f7 100644 --- a/classes/SourceRepo.html +++ b/classes/SourceRepo.html @@ -28,7 +28,7 @@

    Hierarchy

    • SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:38
    • @@ -67,7 +67,7 @@
    props: Returns SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:42

    • Properties

    @@ -77,7 +77,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:40

    • Readonly node

    node: Node
    diff --git a/enums/ImageKind.html b/enums/ImageKind.html index c1397df..8f7c2a6 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -20,7 +20,7 @@

    Enumeration ImageKind

    +
  • Defined in lib/build-image-pipeline.ts:17
    • @@ -39,7 +39,7 @@

    Ubuntu22_04

    +
  • Defined in lib/build-image-pipeline.ts:19
    • diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html index beda325..819ca9c 100644 --- a/enums/ProjectKind.html +++ b/enums/ProjectKind.html @@ -20,7 +20,7 @@

    Enumeration ProjectKind

    +
  • Defined in lib/constructs/source-repo.ts:10
    • @@ -44,7 +44,7 @@

    Poky

    +
  • Defined in lib/constructs/source-repo.ts:12

    • MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"
    @@ -52,7 +52,7 @@

    MetaAwsDemo

    +
  • Defined in lib/constructs/source-repo.ts:14

    • PokyAmi

    PokyAmi: "poky-ami"
    @@ -60,7 +60,7 @@

    PokyAmi

    +
  • Defined in lib/constructs/source-repo.ts:16

    • Kas

    Kas: "kas"
    @@ -68,7 +68,7 @@

    Kas

    +
  • Defined in lib/constructs/source-repo.ts:18

    • Renesas

    Renesas: "renesas"
    @@ -76,7 +76,7 @@

    Renesas

    +
  • Defined in lib/constructs/source-repo.ts:20

    • NxpImx

    NxpImx: "nxp-imx"
    @@ -84,7 +84,7 @@

    NxpImx

    +
  • Defined in lib/constructs/source-repo.ts:22
    • diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html index 599721a..2bc9a7e 100644 --- a/interfaces/BuildImageDataProps.html +++ b/interfaces/BuildImageDataProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataProps
    +
  • Defined in lib/build-image-data.ts:14
    • @@ -55,7 +55,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:16

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/BuildImagePipelineProps.html b/interfaces/BuildImagePipelineProps.html index f45527c..0690eff 100644 --- a/interfaces/BuildImagePipelineProps.html +++ b/interfaces/BuildImagePipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImagePipelineProps
    +
  • Defined in lib/build-image-pipeline.ts:25
    • @@ -57,7 +57,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:27

    • Readonly dataBucket

    dataBucket: IBucket
    @@ -65,7 +65,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:29

    • Readonly repository

    repository: IRepository
    @@ -73,7 +73,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:31

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/EmbeddedLinuxPipelineProps.html b/interfaces/EmbeddedLinuxPipelineProps.html index 623f671..8f7dce2 100644 --- a/interfaces/EmbeddedLinuxPipelineProps.html +++ b/interfaces/EmbeddedLinuxPipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • EmbeddedLinuxPipelineProps
    +
  • Defined in lib/embedded-linux-pipeline.ts:40
    • @@ -59,7 +59,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:42

    • Optional Readonly imageTag

    imageTag?: string
    @@ -67,7 +67,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:44

    • Readonly vpc

    vpc: IVpc
    @@ -75,7 +75,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:46

    • Optional Readonly projectKind

    projectKind?: ProjectKind
    @@ -83,7 +83,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:48

    • Optional Readonly layerRepoName

    layerRepoName?: string
    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:50

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html index 1dd7369..bcb0d33 100644 --- a/interfaces/SourceRepoProps.html +++ b/interfaces/SourceRepoProps.html @@ -22,7 +22,7 @@

    Hierarchy

    • SourceRepoProps
    +
  • Defined in lib/constructs/source-repo.ts:25
    • @@ -52,7 +52,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:27

    • Readonly kind

    kind: ProjectKind
    @@ -60,7 +60,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:29

    • Optional Readonly description

    description?: string
    From dac0aa824c4231201a1ea02049178b1af73aff89 Mon Sep 17 00:00:00 2001 From: nateglims Date: Mon, 8 Jan 2024 17:01:41 +0000 Subject: [PATCH 14/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@c71ab4be4ec201de884a5ff32d?= =?UTF-8?q?cd2bd18571eaa5=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- assets/highlight.css | 16 ++++++------- assets/search.js | 2 +- classes/BuildImageDataStack.html | 12 +++++----- classes/BuildImagePipelineStack.html | 8 +++---- classes/BuildImageRepoStack.html | 10 ++++---- classes/EmbeddedLinuxPipelineStack.html | 20 ++++++++-------- classes/PipelineNetworkStack.html | 10 ++++---- classes/SourceRepo.html | 6 ++--- enums/ImageKind.html | 4 ++-- enums/ProjectKind.html | 14 +++++------ index.html | 14 +++++------ interfaces/BuildImageDataProps.html | 10 ++++---- interfaces/BuildImagePipelineProps.html | 14 +++++------ interfaces/EmbeddedLinuxPipelineProps.html | 28 +++++++++++++++------- interfaces/SourceRepoProps.html | 12 +++++----- 15 files changed, 94 insertions(+), 86 deletions(-) diff --git a/assets/highlight.css b/assets/highlight.css index ff01689..bcb05ac 100644 --- a/assets/highlight.css +++ b/assets/highlight.css @@ -7,16 +7,16 @@ --dark-hl-2: #DCDCAA; --light-hl-3: #A31515; --dark-hl-3: #CE9178; - --light-hl-4: #0451A5; - --dark-hl-4: #9CDCFE; - --light-hl-5: #800000; + --light-hl-4: #AF00DB; + --dark-hl-4: #C586C0; + --light-hl-5: #0000FF; --dark-hl-5: #569CD6; - --light-hl-6: #008000; - --dark-hl-6: #6A9955; - --light-hl-7: #0000FF; + --light-hl-6: #0070C1; + --dark-hl-6: #4FC1FF; + --light-hl-7: #800000; --dark-hl-7: #569CD6; - --light-hl-8: #0070C1; - --dark-hl-8: #4FC1FF; + --light-hl-8: #008000; + --dark-hl-8: #6A9955; --light-hl-9: #267F99; --dark-hl-9: #4EC9B0; --light-code-background: #FFFFFF; diff --git a/assets/search.js b/assets/search.js index b2c8999..fd24389 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"rows\":[{\"kind\":128,\"name\":\"PipelineNetworkStack\",\"url\":\"classes/PipelineNetworkStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/PipelineNetworkStack.html#constructor\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"classes/PipelineNetworkStack.html#vpc\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":256,\"name\":\"BuildImageDataProps\",\"url\":\"interfaces/BuildImageDataProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"bucketName\",\"url\":\"interfaces/BuildImageDataProps.html#bucketName\",\"classes\":\"\",\"parent\":\"BuildImageDataProps\"},{\"kind\":128,\"name\":\"BuildImageDataStack\",\"url\":\"classes/BuildImageDataStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageDataStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":1024,\"name\":\"bucket\",\"url\":\"classes/BuildImageDataStack.html#bucket\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":2048,\"name\":\"createDeploymentBucket\",\"url\":\"classes/BuildImageDataStack.html#createDeploymentBucket\",\"classes\":\"tsd-is-private\",\"parent\":\"BuildImageDataStack\"},{\"kind\":128,\"name\":\"BuildImageRepoStack\",\"url\":\"classes/BuildImageRepoStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageRepoStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"classes/BuildImageRepoStack.html#repository\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":8,\"name\":\"ImageKind\",\"url\":\"enums/ImageKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Ubuntu22_04\",\"url\":\"enums/ImageKind.html#Ubuntu22_04\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":256,\"name\":\"BuildImagePipelineProps\",\"url\":\"interfaces/BuildImagePipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageKind\",\"url\":\"interfaces/BuildImagePipelineProps.html#imageKind\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"dataBucket\",\"url\":\"interfaces/BuildImagePipelineProps.html#dataBucket\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"interfaces/BuildImagePipelineProps.html#repository\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":128,\"name\":\"BuildImagePipelineStack\",\"url\":\"classes/BuildImagePipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImagePipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImagePipelineStack\"},{\"kind\":256,\"name\":\"EmbeddedLinuxPipelineProps\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageRepo\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#imageRepo\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"imageTag\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#imageTag\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#vpc\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"projectKind\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#projectKind\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"layerRepoName\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#layerRepoName\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":128,\"name\":\"EmbeddedLinuxPipelineStack\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addFileSystem\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addFileSystem\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addVMExportPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addVMExportPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIS3BackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIS3BackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEBSBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIEBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEC2EBSBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIEC2EBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":8,\"name\":\"ProjectKind\",\"url\":\"enums/ProjectKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Poky\",\"url\":\"enums/ProjectKind.html#Poky\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"MetaAwsDemo\",\"url\":\"enums/ProjectKind.html#MetaAwsDemo\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"PokyAmi\",\"url\":\"enums/ProjectKind.html#PokyAmi\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Kas\",\"url\":\"enums/ProjectKind.html#Kas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Renesas\",\"url\":\"enums/ProjectKind.html#Renesas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"NxpImx\",\"url\":\"enums/ProjectKind.html#NxpImx\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":256,\"name\":\"SourceRepoProps\",\"url\":\"interfaces/SourceRepoProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"repoName\",\"url\":\"interfaces/SourceRepoProps.html#repoName\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":1024,\"name\":\"kind\",\"url\":\"interfaces/SourceRepoProps.html#kind\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":128,\"name\":\"SourceRepo\",\"url\":\"classes/SourceRepo.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/SourceRepo.html#constructor\",\"classes\":\"\",\"parent\":\"SourceRepo\"},{\"kind\":1024,\"name\":\"repo\",\"url\":\"classes/SourceRepo.html#repo\",\"classes\":\"\",\"parent\":\"SourceRepo\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,34.657]],[\"comment/0\",[]],[\"name/1\",[1,19.994]],[\"comment/1\",[]],[\"name/2\",[2,29.549]],[\"comment/2\",[]],[\"name/3\",[3,34.657]],[\"comment/3\",[]],[\"name/4\",[4,34.657]],[\"comment/4\",[]],[\"name/5\",[5,34.657]],[\"comment/5\",[]],[\"name/6\",[1,19.994]],[\"comment/6\",[]],[\"name/7\",[6,34.657]],[\"comment/7\",[]],[\"name/8\",[7,34.657]],[\"comment/8\",[]],[\"name/9\",[8,34.657]],[\"comment/9\",[]],[\"name/10\",[1,19.994]],[\"comment/10\",[]],[\"name/11\",[9,29.549]],[\"comment/11\",[]],[\"name/12\",[10,29.549]],[\"comment/12\",[]],[\"name/13\",[11,34.657]],[\"comment/13\",[]],[\"name/14\",[12,34.657]],[\"comment/14\",[]],[\"name/15\",[10,29.549]],[\"comment/15\",[]],[\"name/16\",[13,34.657]],[\"comment/16\",[]],[\"name/17\",[9,29.549]],[\"comment/17\",[]],[\"name/18\",[14,34.657]],[\"comment/18\",[]],[\"name/19\",[1,19.994]],[\"comment/19\",[]],[\"name/20\",[15,34.657]],[\"comment/20\",[]],[\"name/21\",[16,34.657]],[\"comment/21\",[]],[\"name/22\",[17,34.657]],[\"comment/22\",[]],[\"name/23\",[2,29.549]],[\"comment/23\",[]],[\"name/24\",[18,29.549]],[\"comment/24\",[]],[\"name/25\",[19,34.657]],[\"comment/25\",[]],[\"name/26\",[20,34.657]],[\"comment/26\",[]],[\"name/27\",[1,19.994]],[\"comment/27\",[]],[\"name/28\",[21,34.657]],[\"comment/28\",[]],[\"name/29\",[22,34.657]],[\"comment/29\",[]],[\"name/30\",[23,34.657]],[\"comment/30\",[]],[\"name/31\",[24,34.657]],[\"comment/31\",[]],[\"name/32\",[25,34.657]],[\"comment/32\",[]],[\"name/33\",[26,34.657]],[\"comment/33\",[]],[\"name/34\",[18,29.549]],[\"comment/34\",[]],[\"name/35\",[27,34.657]],[\"comment/35\",[]],[\"name/36\",[28,34.657]],[\"comment/36\",[]],[\"name/37\",[29,34.657]],[\"comment/37\",[]],[\"name/38\",[30,34.657]],[\"comment/38\",[]],[\"name/39\",[31,34.657]],[\"comment/39\",[]],[\"name/40\",[32,34.657]],[\"comment/40\",[]],[\"name/41\",[33,34.657]],[\"comment/41\",[]],[\"name/42\",[34,34.657]],[\"comment/42\",[]],[\"name/43\",[35,34.657]],[\"comment/43\",[]],[\"name/44\",[36,34.657]],[\"comment/44\",[]],[\"name/45\",[1,19.994]],[\"comment/45\",[]],[\"name/46\",[37,34.657]],[\"comment/46\",[]]],\"invertedIndex\":[[\"addamibackuppolicy\",{\"_index\":25,\"name\":{\"32\":{}},\"comment\":{}}],[\"addamiebsbackuppolicy\",{\"_index\":24,\"name\":{\"31\":{}},\"comment\":{}}],[\"addamiec2ebsbackuppolicy\",{\"_index\":26,\"name\":{\"33\":{}},\"comment\":{}}],[\"addamis3backuppolicy\",{\"_index\":23,\"name\":{\"30\":{}},\"comment\":{}}],[\"addfilesystem\",{\"_index\":21,\"name\":{\"28\":{}},\"comment\":{}}],[\"addvmexportpolicy\",{\"_index\":22,\"name\":{\"29\":{}},\"comment\":{}}],[\"bucket\",{\"_index\":6,\"name\":{\"7\":{}},\"comment\":{}}],[\"bucketname\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"buildimagedataprops\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"buildimagedatastack\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"buildimagepipelineprops\",{\"_index\":12,\"name\":{\"14\":{}},\"comment\":{}}],[\"buildimagepipelinestack\",{\"_index\":14,\"name\":{\"18\":{}},\"comment\":{}}],[\"buildimagerepostack\",{\"_index\":8,\"name\":{\"9\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{},\"6\":{},\"10\":{},\"19\":{},\"27\":{},\"45\":{}},\"comment\":{}}],[\"createdeploymentbucket\",{\"_index\":7,\"name\":{\"8\":{}},\"comment\":{}}],[\"databucket\",{\"_index\":13,\"name\":{\"16\":{}},\"comment\":{}}],[\"embeddedlinuxpipelineprops\",{\"_index\":15,\"name\":{\"20\":{}},\"comment\":{}}],[\"embeddedlinuxpipelinestack\",{\"_index\":20,\"name\":{\"26\":{}},\"comment\":{}}],[\"imagekind\",{\"_index\":10,\"name\":{\"12\":{},\"15\":{}},\"comment\":{}}],[\"imagerepo\",{\"_index\":16,\"name\":{\"21\":{}},\"comment\":{}}],[\"imagetag\",{\"_index\":17,\"name\":{\"22\":{}},\"comment\":{}}],[\"kas\",{\"_index\":30,\"name\":{\"38\":{}},\"comment\":{}}],[\"kind\",{\"_index\":35,\"name\":{\"43\":{}},\"comment\":{}}],[\"layerreponame\",{\"_index\":19,\"name\":{\"25\":{}},\"comment\":{}}],[\"metaawsdemo\",{\"_index\":28,\"name\":{\"36\":{}},\"comment\":{}}],[\"nxpimx\",{\"_index\":32,\"name\":{\"40\":{}},\"comment\":{}}],[\"pipelinenetworkstack\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"poky\",{\"_index\":27,\"name\":{\"35\":{}},\"comment\":{}}],[\"pokyami\",{\"_index\":29,\"name\":{\"37\":{}},\"comment\":{}}],[\"projectkind\",{\"_index\":18,\"name\":{\"24\":{},\"34\":{}},\"comment\":{}}],[\"renesas\",{\"_index\":31,\"name\":{\"39\":{}},\"comment\":{}}],[\"repo\",{\"_index\":37,\"name\":{\"46\":{}},\"comment\":{}}],[\"reponame\",{\"_index\":34,\"name\":{\"42\":{}},\"comment\":{}}],[\"repository\",{\"_index\":9,\"name\":{\"11\":{},\"17\":{}},\"comment\":{}}],[\"sourcerepo\",{\"_index\":36,\"name\":{\"44\":{}},\"comment\":{}}],[\"sourcerepoprops\",{\"_index\":33,\"name\":{\"41\":{}},\"comment\":{}}],[\"ubuntu22_04\",{\"_index\":11,\"name\":{\"13\":{}},\"comment\":{}}],[\"vpc\",{\"_index\":2,\"name\":{\"2\":{},\"23\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = JSON.parse("{\"rows\":[{\"kind\":128,\"name\":\"PipelineNetworkStack\",\"url\":\"classes/PipelineNetworkStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/PipelineNetworkStack.html#constructor\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"classes/PipelineNetworkStack.html#vpc\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":256,\"name\":\"BuildImageDataProps\",\"url\":\"interfaces/BuildImageDataProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"bucketName\",\"url\":\"interfaces/BuildImageDataProps.html#bucketName\",\"classes\":\"\",\"parent\":\"BuildImageDataProps\"},{\"kind\":128,\"name\":\"BuildImageDataStack\",\"url\":\"classes/BuildImageDataStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageDataStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":1024,\"name\":\"bucket\",\"url\":\"classes/BuildImageDataStack.html#bucket\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":2048,\"name\":\"createDeploymentBucket\",\"url\":\"classes/BuildImageDataStack.html#createDeploymentBucket\",\"classes\":\"tsd-is-private\",\"parent\":\"BuildImageDataStack\"},{\"kind\":128,\"name\":\"BuildImageRepoStack\",\"url\":\"classes/BuildImageRepoStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageRepoStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"classes/BuildImageRepoStack.html#repository\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":8,\"name\":\"ImageKind\",\"url\":\"enums/ImageKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Ubuntu22_04\",\"url\":\"enums/ImageKind.html#Ubuntu22_04\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":256,\"name\":\"BuildImagePipelineProps\",\"url\":\"interfaces/BuildImagePipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageKind\",\"url\":\"interfaces/BuildImagePipelineProps.html#imageKind\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"dataBucket\",\"url\":\"interfaces/BuildImagePipelineProps.html#dataBucket\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"interfaces/BuildImagePipelineProps.html#repository\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":128,\"name\":\"BuildImagePipelineStack\",\"url\":\"classes/BuildImagePipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImagePipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImagePipelineStack\"},{\"kind\":256,\"name\":\"EmbeddedLinuxPipelineProps\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageRepo\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#imageRepo\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"imageTag\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#imageTag\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#vpc\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"projectKind\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#projectKind\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"layerRepoName\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#layerRepoName\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"buildPolicyAdditions\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#buildPolicyAdditions\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":128,\"name\":\"EmbeddedLinuxPipelineStack\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addFileSystem\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addFileSystem\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addVMExportPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addVMExportPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIS3BackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIS3BackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEBSBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIEBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEC2EBSBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIEC2EBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":8,\"name\":\"ProjectKind\",\"url\":\"enums/ProjectKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Poky\",\"url\":\"enums/ProjectKind.html#Poky\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"MetaAwsDemo\",\"url\":\"enums/ProjectKind.html#MetaAwsDemo\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"PokyAmi\",\"url\":\"enums/ProjectKind.html#PokyAmi\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Kas\",\"url\":\"enums/ProjectKind.html#Kas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Renesas\",\"url\":\"enums/ProjectKind.html#Renesas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"NxpImx\",\"url\":\"enums/ProjectKind.html#NxpImx\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":256,\"name\":\"SourceRepoProps\",\"url\":\"interfaces/SourceRepoProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"repoName\",\"url\":\"interfaces/SourceRepoProps.html#repoName\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":1024,\"name\":\"kind\",\"url\":\"interfaces/SourceRepoProps.html#kind\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":128,\"name\":\"SourceRepo\",\"url\":\"classes/SourceRepo.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/SourceRepo.html#constructor\",\"classes\":\"\",\"parent\":\"SourceRepo\"},{\"kind\":1024,\"name\":\"repo\",\"url\":\"classes/SourceRepo.html#repo\",\"classes\":\"\",\"parent\":\"SourceRepo\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,34.864]],[\"comment/0\",[]],[\"name/1\",[1,20.2]],[\"comment/1\",[]],[\"name/2\",[2,29.755]],[\"comment/2\",[]],[\"name/3\",[3,34.864]],[\"comment/3\",[]],[\"name/4\",[4,34.864]],[\"comment/4\",[]],[\"name/5\",[5,34.864]],[\"comment/5\",[]],[\"name/6\",[1,20.2]],[\"comment/6\",[]],[\"name/7\",[6,34.864]],[\"comment/7\",[]],[\"name/8\",[7,34.864]],[\"comment/8\",[]],[\"name/9\",[8,34.864]],[\"comment/9\",[]],[\"name/10\",[1,20.2]],[\"comment/10\",[]],[\"name/11\",[9,29.755]],[\"comment/11\",[]],[\"name/12\",[10,29.755]],[\"comment/12\",[]],[\"name/13\",[11,34.864]],[\"comment/13\",[]],[\"name/14\",[12,34.864]],[\"comment/14\",[]],[\"name/15\",[10,29.755]],[\"comment/15\",[]],[\"name/16\",[13,34.864]],[\"comment/16\",[]],[\"name/17\",[9,29.755]],[\"comment/17\",[]],[\"name/18\",[14,34.864]],[\"comment/18\",[]],[\"name/19\",[1,20.2]],[\"comment/19\",[]],[\"name/20\",[15,34.864]],[\"comment/20\",[]],[\"name/21\",[16,34.864]],[\"comment/21\",[]],[\"name/22\",[17,34.864]],[\"comment/22\",[]],[\"name/23\",[2,29.755]],[\"comment/23\",[]],[\"name/24\",[18,29.755]],[\"comment/24\",[]],[\"name/25\",[19,34.864]],[\"comment/25\",[]],[\"name/26\",[20,34.864]],[\"comment/26\",[]],[\"name/27\",[21,34.864]],[\"comment/27\",[]],[\"name/28\",[1,20.2]],[\"comment/28\",[]],[\"name/29\",[22,34.864]],[\"comment/29\",[]],[\"name/30\",[23,34.864]],[\"comment/30\",[]],[\"name/31\",[24,34.864]],[\"comment/31\",[]],[\"name/32\",[25,34.864]],[\"comment/32\",[]],[\"name/33\",[26,34.864]],[\"comment/33\",[]],[\"name/34\",[27,34.864]],[\"comment/34\",[]],[\"name/35\",[18,29.755]],[\"comment/35\",[]],[\"name/36\",[28,34.864]],[\"comment/36\",[]],[\"name/37\",[29,34.864]],[\"comment/37\",[]],[\"name/38\",[30,34.864]],[\"comment/38\",[]],[\"name/39\",[31,34.864]],[\"comment/39\",[]],[\"name/40\",[32,34.864]],[\"comment/40\",[]],[\"name/41\",[33,34.864]],[\"comment/41\",[]],[\"name/42\",[34,34.864]],[\"comment/42\",[]],[\"name/43\",[35,34.864]],[\"comment/43\",[]],[\"name/44\",[36,34.864]],[\"comment/44\",[]],[\"name/45\",[37,34.864]],[\"comment/45\",[]],[\"name/46\",[1,20.2]],[\"comment/46\",[]],[\"name/47\",[38,34.864]],[\"comment/47\",[]]],\"invertedIndex\":[[\"addamibackuppolicy\",{\"_index\":26,\"name\":{\"33\":{}},\"comment\":{}}],[\"addamiebsbackuppolicy\",{\"_index\":25,\"name\":{\"32\":{}},\"comment\":{}}],[\"addamiec2ebsbackuppolicy\",{\"_index\":27,\"name\":{\"34\":{}},\"comment\":{}}],[\"addamis3backuppolicy\",{\"_index\":24,\"name\":{\"31\":{}},\"comment\":{}}],[\"addfilesystem\",{\"_index\":22,\"name\":{\"29\":{}},\"comment\":{}}],[\"addvmexportpolicy\",{\"_index\":23,\"name\":{\"30\":{}},\"comment\":{}}],[\"bucket\",{\"_index\":6,\"name\":{\"7\":{}},\"comment\":{}}],[\"bucketname\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"buildimagedataprops\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"buildimagedatastack\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"buildimagepipelineprops\",{\"_index\":12,\"name\":{\"14\":{}},\"comment\":{}}],[\"buildimagepipelinestack\",{\"_index\":14,\"name\":{\"18\":{}},\"comment\":{}}],[\"buildimagerepostack\",{\"_index\":8,\"name\":{\"9\":{}},\"comment\":{}}],[\"buildpolicyadditions\",{\"_index\":20,\"name\":{\"26\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{},\"6\":{},\"10\":{},\"19\":{},\"28\":{},\"46\":{}},\"comment\":{}}],[\"createdeploymentbucket\",{\"_index\":7,\"name\":{\"8\":{}},\"comment\":{}}],[\"databucket\",{\"_index\":13,\"name\":{\"16\":{}},\"comment\":{}}],[\"embeddedlinuxpipelineprops\",{\"_index\":15,\"name\":{\"20\":{}},\"comment\":{}}],[\"embeddedlinuxpipelinestack\",{\"_index\":21,\"name\":{\"27\":{}},\"comment\":{}}],[\"imagekind\",{\"_index\":10,\"name\":{\"12\":{},\"15\":{}},\"comment\":{}}],[\"imagerepo\",{\"_index\":16,\"name\":{\"21\":{}},\"comment\":{}}],[\"imagetag\",{\"_index\":17,\"name\":{\"22\":{}},\"comment\":{}}],[\"kas\",{\"_index\":31,\"name\":{\"39\":{}},\"comment\":{}}],[\"kind\",{\"_index\":36,\"name\":{\"44\":{}},\"comment\":{}}],[\"layerreponame\",{\"_index\":19,\"name\":{\"25\":{}},\"comment\":{}}],[\"metaawsdemo\",{\"_index\":29,\"name\":{\"37\":{}},\"comment\":{}}],[\"nxpimx\",{\"_index\":33,\"name\":{\"41\":{}},\"comment\":{}}],[\"pipelinenetworkstack\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"poky\",{\"_index\":28,\"name\":{\"36\":{}},\"comment\":{}}],[\"pokyami\",{\"_index\":30,\"name\":{\"38\":{}},\"comment\":{}}],[\"projectkind\",{\"_index\":18,\"name\":{\"24\":{},\"35\":{}},\"comment\":{}}],[\"renesas\",{\"_index\":32,\"name\":{\"40\":{}},\"comment\":{}}],[\"repo\",{\"_index\":38,\"name\":{\"47\":{}},\"comment\":{}}],[\"reponame\",{\"_index\":35,\"name\":{\"43\":{}},\"comment\":{}}],[\"repository\",{\"_index\":9,\"name\":{\"11\":{},\"17\":{}},\"comment\":{}}],[\"sourcerepo\",{\"_index\":37,\"name\":{\"45\":{}},\"comment\":{}}],[\"sourcerepoprops\",{\"_index\":34,\"name\":{\"42\":{}},\"comment\":{}}],[\"ubuntu22_04\",{\"_index\":11,\"name\":{\"13\":{}},\"comment\":{}}],[\"vpc\",{\"_index\":2,\"name\":{\"2\":{},\"23\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html index 677733e..3e722e0 100644 --- a/classes/BuildImageDataStack.html +++ b/classes/BuildImageDataStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:22
    • @@ -116,7 +116,7 @@
    props: Returns BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:26

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:24

    • Readonly tags

    tags: TagManager
    @@ -378,7 +378,7 @@

    stackId

    Returns string

    -

    Example

    // After resolving, looks like
    'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+
    Example
    // After resolving, looks like
    'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'

    +
  • Defined in lib/build-image-data.ts:38

    • Static isStack

    @@ -116,7 +116,7 @@
    props: Returns BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:41

    • Properties

    @@ -370,7 +370,7 @@

    stackId

    Returns string

    -

    Example

    // After resolving, looks like
    'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+
    Example
    // After resolving, looks like
    'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'

    @@ -116,7 +116,7 @@
    Optional Returns BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:14

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-repo.ts:12

    • Readonly tags

    tags: TagManager
    @@ -378,7 +378,7 @@

    stackId

    Returns string

    -

    Example

    // After resolving, looks like
    'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+
    Example
    // After resolving, looks like
    'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'

    @@ -121,7 +121,7 @@
    props: Returns EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:61

    • Properties

    @@ -375,7 +375,7 @@

    stackId

    Returns string

    -

    Example

    // After resolving, looks like
    'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+
    Example
    // After resolving, looks like
    'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'

    +
  • Defined in lib/embedded-linux-pipeline.ts:344

    • Private addVMExportPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:361

    • Private addAMIS3BackupPolicy

      @@ -515,7 +515,7 @@

      Parameters

      artifactBucketArn: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:376

    • Private addAMIEBSBackupPolicy

      @@ -528,7 +528,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:388

    • Private addAMIBackupPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:401

    • Private addAMIEC2EBSBackupPolicy

      @@ -549,7 +549,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:408

    • Static isStack

      @@ -809,7 +809,7 @@

      Returns void

      See

      https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

      -

      Example

      declare const stack: Stack;

      stack.addTransform('AWS::Serverless-2016-10-31')
+
      Example
      declare const stack: Stack;

      stack.addTransform('AWS::Serverless-2016-10-31')

    +
  • Defined in lib/network.ts:12
    • @@ -115,7 +115,7 @@
    Optional Returns PipelineNetworkStack
    +
  • Defined in lib/network.ts:16

    • Properties

    @@ -125,7 +125,7 @@

    Readonly

    +
  • Defined in lib/network.ts:14

    • Readonly tags

    tags: TagManager
    @@ -377,7 +377,7 @@

    stackId

    Returns string

    -

    Example

    // After resolving, looks like
    'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+
    Example
    // After resolving, looks like
    'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'

    +
  • Defined in lib/constructs/source-repo.ts:38
    • @@ -67,7 +67,7 @@
    props: Returns SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:42

    • Properties

    @@ -77,7 +77,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:40

    • Readonly node

    node: Node
    diff --git a/enums/ImageKind.html b/enums/ImageKind.html index 8f7c2a6..985a609 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -20,7 +20,7 @@

    Enumeration ImageKind

    +
  • Defined in lib/build-image-pipeline.ts:17
    • @@ -39,7 +39,7 @@

    Ubuntu22_04

    +
  • Defined in lib/build-image-pipeline.ts:19
    • diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html index 819ca9c..f6769be 100644 --- a/enums/ProjectKind.html +++ b/enums/ProjectKind.html @@ -20,7 +20,7 @@

    Enumeration ProjectKind

    +
  • Defined in lib/constructs/source-repo.ts:10
    • @@ -44,7 +44,7 @@

    Poky

    +
  • Defined in lib/constructs/source-repo.ts:12

    • MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"
    @@ -52,7 +52,7 @@

    MetaAwsDemo

    +
  • Defined in lib/constructs/source-repo.ts:14

    • PokyAmi

    PokyAmi: "poky-ami"
    @@ -60,7 +60,7 @@

    PokyAmi

    +
  • Defined in lib/constructs/source-repo.ts:16

    • Kas

    Kas: "kas"
    @@ -68,7 +68,7 @@

    Kas

    +
  • Defined in lib/constructs/source-repo.ts:18

    • Renesas

    Renesas: "renesas"
    @@ -76,7 +76,7 @@

    Renesas

    +
  • Defined in lib/constructs/source-repo.ts:20

    • NxpImx

    NxpImx: "nxp-imx"
    @@ -84,7 +84,7 @@

    NxpImx

    +
  • Defined in lib/constructs/source-repo.ts:22
    • diff --git a/index.html b/index.html index 67e697c..ce45187 100644 --- a/index.html +++ b/index.html @@ -56,17 +56,15 @@

    aws4embeddedlinux-cdk-lib

    source repos, etc.

    1. Create a Secret in Secrets Manager and add your secret value.
      2. -
    2. Grant access permissions to the CodeBuild pipeline project.
        -
      1. Find the IAM role for the CodeBuild Project in the CodeBuild console page under the "Build Details". This is also called the "Service Role".
        2. -
      2. In the IAM console page, add a new policy, replacing <Secret ARN> with the ARN of the secret created.
        {
            "Version": "2012-10-17",
            "Statement": [ {
                "Effect": "Allow",
                "Action": "secretsmanager:GetSecretValue",
                "Resource": "<Secret ARN>"
            } ]
        }
-
        -
        3. -
      -
      3. +
    3. Grant access permissions to the CodeBuild pipeline project.
      4. +
    4. Create a Policy Statement which allows secretsmanager:GetSecretValue for your secret.
      5. +
    5. Add this policy statement to the buildPolicyAdditions props for the EmbeddedLinuxPipelineStack. e.g.
    +
    import * as iam from "aws-cdk-lib/aws-iam";


    const pipeline = new EmbeddedLinuxPipelineStack(app, "MyPokyPipeline", {
      imageRepo: buildImageRepo.repository,
      imageTag: ImageKind.Ubuntu22_04,
      vpc: vpc.vpc,
      buildPolicyAdditions: [
        iam.PolicyStatement.fromJson({
          Effect: "Allow",
          Action: "secretsmanager:GetSecretValue",
          Resource:
            "arn:aws:secretsmanager:us-west-2:123456789012:secret:my-secret-??????",
        }),
      ],
    });
+

    The secret can then be used in the CodeBuild Project by adding it to the BuildSpec. See the CodeBuild Documentation for more details.

    -
    env:
        secrets-manager:
            SECRET_VALUE: "<Secret ARN>"
+
    env:
        secrets-manager:
            SECRET_VALUE: "<Secret ARN>"
 
    
 
    CVE Checking With Yocto
    CVE checking is enabled in the reference implementations. Details on this can be found in
 the yocto documentation.
    
diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html
index 2bc9a7e..15069e9 100644
--- a/interfaces/BuildImageDataProps.html
+++ b/interfaces/BuildImageDataProps.html
@@ -26,7 +26,7 @@ 
    Hierarchy
    
 
      
 
    • BuildImageDataProps
    
+
  • Defined in lib/build-image-data.ts:14
    • 
 
    
 
    
 
    
@@ -55,7 +55,7 @@ 
    Readonly
 
    
+
  • Defined in lib/build-image-data.ts:16
    • 
 
    
 
    Optional Readonly description
    
 
    description?: string
    
@@ -90,7 +90,7 @@ 
    Optional
    -

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
+
    Example
    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
 
    
 
 
    Default
      
@@ -157,7 +157,7 @@ 
      Optional
      Whether to enable termination protection for this stack.
    -

    Default

    false
+
    Default
    false
    -

    Default

    false
+
    Default
    false
    @@ -57,7 +57,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:27

    • Readonly dataBucket

    dataBucket: IBucket
    @@ -65,7 +65,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:29

    • Readonly repository

    repository: IRepository
    @@ -73,7 +73,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:31

    • Optional Readonly description

    description?: string
    @@ -108,7 +108,7 @@

    Optional
    -

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
+
    Example
    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
 
    
 
 
    Default
      
@@ -175,7 +175,7 @@ 
      Optional
      Whether to enable termination protection for this stack.
    -

    Default

    false
+
    Default
    false

    +
  • Defined in lib/embedded-linux-pipeline.ts:40
    • @@ -39,6 +39,7 @@

    Properties

    vpc projectKind? layerRepoName? +buildPolicyAdditions? description? env? stackName? @@ -59,7 +60,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:42

    • Optional Readonly imageTag

    imageTag?: string
    @@ -67,7 +68,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:44

    • Readonly vpc

    vpc: IVpc
    @@ -75,7 +76,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:46

    • Optional Readonly projectKind

    projectKind?: ProjectKind
    @@ -83,7 +84,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:48

    • Optional Readonly layerRepoName

    layerRepoName?: string
    @@ -91,7 +92,15 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:50
    • +
    +

    Optional Readonly buildPolicyAdditions

    +
    buildPolicyAdditions?: PolicyStatement[]
    +

    Additional policy statements to add to the build project.

    +
    +

    Optional Readonly description

    description?: string
    @@ -126,7 +135,7 @@

    Optional
    -

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
+
    Example
    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
 
    
 
 
    Default
      
@@ -193,7 +202,7 @@ 
      Optional
      Whether to enable termination protection for this stack.
    -

    Default

    false
+
    Default
    false

    +
  • Defined in lib/constructs/source-repo.ts:25
    • @@ -52,7 +52,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:27

    • Readonly kind

    kind: ProjectKind
    @@ -60,7 +60,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:29

    • Optional Readonly description

    description?: string
    @@ -95,7 +95,7 @@

    Optional
    -

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
+
    Example
    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
 
    
 
 
    Default
      
@@ -162,7 +162,7 @@ 
      Optional
      Whether to enable termination protection for this stack.
    -

    Default

    false
+
    Default
    false

    +
  • Defined in lib/build-image-data.ts:22
    • @@ -116,7 +116,7 @@
    props: Returns BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:26

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:24

    • Readonly tags

    tags: TagManager
    @@ -486,7 +486,7 @@
    bucketName: Returns IBucket
    +
  • Defined in lib/build-image-data.ts:38

    • Static isStack

      diff --git a/classes/BuildImagePipelineStack.html b/classes/BuildImagePipelineStack.html index de3e9d0..88b22d9 100644 --- a/classes/BuildImagePipelineStack.html +++ b/classes/BuildImagePipelineStack.html @@ -28,7 +28,7 @@

      Hierarchy

      • BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:40
    • @@ -116,7 +116,7 @@
    props: Returns BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:41

    • Properties

    diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html index 1166dae..503b10f 100644 --- a/classes/BuildImageRepoStack.html +++ b/classes/BuildImageRepoStack.html @@ -27,7 +27,7 @@

    Hierarchy

    • BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:10
    • @@ -116,7 +116,7 @@
    Optional Returns BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:14

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-repo.ts:12

    • Readonly tags

    tags: TagManager
    diff --git a/classes/EmbeddedLinuxPipelineStack.html b/classes/EmbeddedLinuxPipelineStack.html index 5b70231..7f5a5c4 100644 --- a/classes/EmbeddedLinuxPipelineStack.html +++ b/classes/EmbeddedLinuxPipelineStack.html @@ -27,7 +27,7 @@

    Hierarchy

    • EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:60
    • @@ -121,7 +121,7 @@
    props: Returns EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:61

    • Properties

    @@ -494,7 +494,7 @@

    Returns string

    +
  • Defined in lib/embedded-linux-pipeline.ts:344

    • Private addVMExportPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:361

    • Private addAMIS3BackupPolicy

      @@ -515,7 +515,7 @@

      Parameters

      artifactBucketArn: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:376

    • Private addAMIEBSBackupPolicy

      @@ -528,7 +528,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:388

    • Private addAMIBackupPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:401

    • Private addAMIEC2EBSBackupPolicy

      @@ -549,7 +549,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:408

    • Static isStack

      diff --git a/classes/PipelineNetworkStack.html b/classes/PipelineNetworkStack.html index 3944d65..d0db026 100644 --- a/classes/PipelineNetworkStack.html +++ b/classes/PipelineNetworkStack.html @@ -28,7 +28,7 @@

      Hierarchy

      • PipelineNetworkStack
    +
  • Defined in lib/network.ts:12
    • @@ -115,7 +115,7 @@
    Optional Returns PipelineNetworkStack
    +
  • Defined in lib/network.ts:16

    • Properties

    @@ -125,7 +125,7 @@

    Readonly

    +
  • Defined in lib/network.ts:14

    • Readonly tags

    tags: TagManager
    diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html index f43d93b..dac02a6 100644 --- a/classes/SourceRepo.html +++ b/classes/SourceRepo.html @@ -28,7 +28,7 @@

    Hierarchy

    • SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:38
    • @@ -67,7 +67,7 @@
    props: Returns SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:42

    • Properties

    @@ -77,7 +77,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:40

    • Readonly node

    node: Node
    diff --git a/enums/ImageKind.html b/enums/ImageKind.html index 985a609..73b658b 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -20,7 +20,7 @@

    Enumeration ImageKind

    +
  • Defined in lib/build-image-pipeline.ts:17
    • @@ -39,7 +39,7 @@

    Ubuntu22_04

    +
  • Defined in lib/build-image-pipeline.ts:19
    • diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html index f6769be..14e7c2f 100644 --- a/enums/ProjectKind.html +++ b/enums/ProjectKind.html @@ -20,7 +20,7 @@

    Enumeration ProjectKind

    +
  • Defined in lib/constructs/source-repo.ts:10
    • @@ -44,7 +44,7 @@

    Poky

    +
  • Defined in lib/constructs/source-repo.ts:12

    • MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"
    @@ -52,7 +52,7 @@

    MetaAwsDemo

    +
  • Defined in lib/constructs/source-repo.ts:14

    • PokyAmi

    PokyAmi: "poky-ami"
    @@ -60,7 +60,7 @@

    PokyAmi

    +
  • Defined in lib/constructs/source-repo.ts:16

    • Kas

    Kas: "kas"
    @@ -68,7 +68,7 @@

    Kas

    +
  • Defined in lib/constructs/source-repo.ts:18

    • Renesas

    Renesas: "renesas"
    @@ -76,7 +76,7 @@

    Renesas

    +
  • Defined in lib/constructs/source-repo.ts:20

    • NxpImx

    NxpImx: "nxp-imx"
    @@ -84,7 +84,7 @@

    NxpImx

    +
  • Defined in lib/constructs/source-repo.ts:22
    • diff --git a/index.html b/index.html index ce45187..a0b5f12 100644 --- a/index.html +++ b/index.html @@ -37,6 +37,7 @@

    aws4embeddedlinux-cdk-lib

    this container patched.
  • Now the application pipeline can be run. This will push the contents of the Yocto deploy directory into S3.
    • +

    Viewing Changes

    The cdk diff command can be used to preview changes before deployment. This will allow the user to review what is being created.

    Development Setup

    You can use npm link to develop with a local copy of this repo.

    In this library repo:

    npm install
    @@ -102,6 +103,7 @@

    Quickstart
  • Setting Up A New Project
    • +
  • Viewing Changes
  • Development Setup
    • diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html index 15069e9..2b306ce 100644 --- a/interfaces/BuildImageDataProps.html +++ b/interfaces/BuildImageDataProps.html @@ -26,7 +26,7 @@

      Hierarchy

      • BuildImageDataProps
    +
  • Defined in lib/build-image-data.ts:14
    • @@ -55,7 +55,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:16

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/BuildImagePipelineProps.html b/interfaces/BuildImagePipelineProps.html index f4eb182..e7f143f 100644 --- a/interfaces/BuildImagePipelineProps.html +++ b/interfaces/BuildImagePipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImagePipelineProps
    +
  • Defined in lib/build-image-pipeline.ts:25
    • @@ -57,7 +57,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:27

    • Readonly dataBucket

    dataBucket: IBucket
    @@ -65,7 +65,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:29

    • Readonly repository

    repository: IRepository
    @@ -73,7 +73,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:31

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/EmbeddedLinuxPipelineProps.html b/interfaces/EmbeddedLinuxPipelineProps.html index b6d4869..354ee99 100644 --- a/interfaces/EmbeddedLinuxPipelineProps.html +++ b/interfaces/EmbeddedLinuxPipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • EmbeddedLinuxPipelineProps
    +
  • Defined in lib/embedded-linux-pipeline.ts:40
    • @@ -60,7 +60,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:42

    • Optional Readonly imageTag

    imageTag?: string
    @@ -68,7 +68,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:44

    • Readonly vpc

    vpc: IVpc
    @@ -76,7 +76,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:46

    • Optional Readonly projectKind

    projectKind?: ProjectKind
    @@ -84,7 +84,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:48

    • Optional Readonly layerRepoName

    layerRepoName?: string
    @@ -92,7 +92,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:50

    • Optional Readonly buildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]
    @@ -100,7 +100,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:52

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html index 2107428..92050d9 100644 --- a/interfaces/SourceRepoProps.html +++ b/interfaces/SourceRepoProps.html @@ -22,7 +22,7 @@

    Hierarchy

    • SourceRepoProps
    +
  • Defined in lib/constructs/source-repo.ts:25
    • @@ -52,7 +52,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:27

    • Readonly kind

    kind: ProjectKind
    @@ -60,7 +60,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:29

    • Optional Readonly description

    description?: string
    From c1b0568d080a10ad6590a5a4a26b3ab92258ccac Mon Sep 17 00:00:00 2001 From: nateglims Date: Tue, 9 Jan 2024 21:06:34 +0000 Subject: [PATCH 16/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@45f22e421b3ec9b5f911d715a2?= =?UTF-8?q?058a1b1a2b5e96=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/BuildImageDataStack.html | 8 ++++---- classes/BuildImagePipelineStack.html | 4 ++-- classes/BuildImageRepoStack.html | 6 +++--- classes/EmbeddedLinuxPipelineStack.html | 16 ++++++++-------- classes/PipelineNetworkStack.html | 6 +++--- classes/SourceRepo.html | 6 +++--- enums/ImageKind.html | 4 ++-- enums/ProjectKind.html | 14 +++++++------- interfaces/BuildImageDataProps.html | 4 ++-- interfaces/BuildImagePipelineProps.html | 8 ++++---- interfaces/EmbeddedLinuxPipelineProps.html | 14 +++++++------- interfaces/SourceRepoProps.html | 6 +++--- 12 files changed, 48 insertions(+), 48 deletions(-) diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html index 5589a46..90605a1 100644 --- a/classes/BuildImageDataStack.html +++ b/classes/BuildImageDataStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:22
    • @@ -116,7 +116,7 @@
    props: Returns BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:26

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:24

    • Readonly tags

    tags: TagManager
    @@ -486,7 +486,7 @@
    bucketName: Returns IBucket
    +
  • Defined in lib/build-image-data.ts:38

    • Static isStack

      diff --git a/classes/BuildImagePipelineStack.html b/classes/BuildImagePipelineStack.html index 88b22d9..ccb0f54 100644 --- a/classes/BuildImagePipelineStack.html +++ b/classes/BuildImagePipelineStack.html @@ -28,7 +28,7 @@

      Hierarchy

      • BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:40
    • @@ -116,7 +116,7 @@
    props: Returns BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:41

    • Properties

    diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html index 503b10f..c6b366c 100644 --- a/classes/BuildImageRepoStack.html +++ b/classes/BuildImageRepoStack.html @@ -27,7 +27,7 @@

    Hierarchy

    • BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:10
    • @@ -116,7 +116,7 @@
    Optional Returns BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:14

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-repo.ts:12

    • Readonly tags

    tags: TagManager
    diff --git a/classes/EmbeddedLinuxPipelineStack.html b/classes/EmbeddedLinuxPipelineStack.html index 7f5a5c4..cc1a8d8 100644 --- a/classes/EmbeddedLinuxPipelineStack.html +++ b/classes/EmbeddedLinuxPipelineStack.html @@ -27,7 +27,7 @@

    Hierarchy

    • EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:60
    • @@ -121,7 +121,7 @@
    props: Returns EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:61

    • Properties

    @@ -494,7 +494,7 @@

    Returns string

    +
  • Defined in lib/embedded-linux-pipeline.ts:344

    • Private addVMExportPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:361

    • Private addAMIS3BackupPolicy

      @@ -515,7 +515,7 @@

      Parameters

      artifactBucketArn: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:376

    • Private addAMIEBSBackupPolicy

      @@ -528,7 +528,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:388

    • Private addAMIBackupPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:401

    • Private addAMIEC2EBSBackupPolicy

      @@ -549,7 +549,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:408

    • Static isStack

      diff --git a/classes/PipelineNetworkStack.html b/classes/PipelineNetworkStack.html index d0db026..a84133d 100644 --- a/classes/PipelineNetworkStack.html +++ b/classes/PipelineNetworkStack.html @@ -28,7 +28,7 @@

      Hierarchy

      • PipelineNetworkStack
    +
  • Defined in lib/network.ts:12
    • @@ -115,7 +115,7 @@
    Optional Returns PipelineNetworkStack
    +
  • Defined in lib/network.ts:16

    • Properties

    @@ -125,7 +125,7 @@

    Readonly

    +
  • Defined in lib/network.ts:14

    • Readonly tags

    tags: TagManager
    diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html index dac02a6..8982086 100644 --- a/classes/SourceRepo.html +++ b/classes/SourceRepo.html @@ -28,7 +28,7 @@

    Hierarchy

    • SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:38
    • @@ -67,7 +67,7 @@
    props: Returns SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:42

    • Properties

    @@ -77,7 +77,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:40

    • Readonly node

    node: Node
    diff --git a/enums/ImageKind.html b/enums/ImageKind.html index 73b658b..682fbb6 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -20,7 +20,7 @@

    Enumeration ImageKind

    +
  • Defined in lib/build-image-pipeline.ts:17
    • @@ -39,7 +39,7 @@

    Ubuntu22_04

    +
  • Defined in lib/build-image-pipeline.ts:19
    • diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html index 14e7c2f..a6d3752 100644 --- a/enums/ProjectKind.html +++ b/enums/ProjectKind.html @@ -20,7 +20,7 @@

    Enumeration ProjectKind

    +
  • Defined in lib/constructs/source-repo.ts:10
    • @@ -44,7 +44,7 @@

    Poky

    +
  • Defined in lib/constructs/source-repo.ts:12

    • MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"
    @@ -52,7 +52,7 @@

    MetaAwsDemo

    +
  • Defined in lib/constructs/source-repo.ts:14

    • PokyAmi

    PokyAmi: "poky-ami"
    @@ -60,7 +60,7 @@

    PokyAmi

    +
  • Defined in lib/constructs/source-repo.ts:16

    • Kas

    Kas: "kas"
    @@ -68,7 +68,7 @@

    Kas

    +
  • Defined in lib/constructs/source-repo.ts:18

    • Renesas

    Renesas: "renesas"
    @@ -76,7 +76,7 @@

    Renesas

    +
  • Defined in lib/constructs/source-repo.ts:20

    • NxpImx

    NxpImx: "nxp-imx"
    @@ -84,7 +84,7 @@

    NxpImx

    +
  • Defined in lib/constructs/source-repo.ts:22
    • diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html index 2b306ce..da7e455 100644 --- a/interfaces/BuildImageDataProps.html +++ b/interfaces/BuildImageDataProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataProps
    +
  • Defined in lib/build-image-data.ts:14
    • @@ -55,7 +55,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:16

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/BuildImagePipelineProps.html b/interfaces/BuildImagePipelineProps.html index e7f143f..7cada41 100644 --- a/interfaces/BuildImagePipelineProps.html +++ b/interfaces/BuildImagePipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImagePipelineProps
    +
  • Defined in lib/build-image-pipeline.ts:25
    • @@ -57,7 +57,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:27

    • Readonly dataBucket

    dataBucket: IBucket
    @@ -65,7 +65,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:29

    • Readonly repository

    repository: IRepository
    @@ -73,7 +73,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:31

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/EmbeddedLinuxPipelineProps.html b/interfaces/EmbeddedLinuxPipelineProps.html index 354ee99..e9b0604 100644 --- a/interfaces/EmbeddedLinuxPipelineProps.html +++ b/interfaces/EmbeddedLinuxPipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • EmbeddedLinuxPipelineProps
    +
  • Defined in lib/embedded-linux-pipeline.ts:40
    • @@ -60,7 +60,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:42

    • Optional Readonly imageTag

    imageTag?: string
    @@ -68,7 +68,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:44

    • Readonly vpc

    vpc: IVpc
    @@ -76,7 +76,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:46

    • Optional Readonly projectKind

    projectKind?: ProjectKind
    @@ -84,7 +84,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:48

    • Optional Readonly layerRepoName

    layerRepoName?: string
    @@ -92,7 +92,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:50

    • Optional Readonly buildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]
    @@ -100,7 +100,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:52

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html index 92050d9..36224ee 100644 --- a/interfaces/SourceRepoProps.html +++ b/interfaces/SourceRepoProps.html @@ -22,7 +22,7 @@

    Hierarchy

    • SourceRepoProps
    +
  • Defined in lib/constructs/source-repo.ts:25
    • @@ -52,7 +52,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:27

    • Readonly kind

    kind: ProjectKind
    @@ -60,7 +60,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:29

    • Optional Readonly description

    description?: string
    From 148842c29c20e6ae18732481f7b22797f70c3a50 Mon Sep 17 00:00:00 2001 From: nateglims Date: Wed, 10 Jan 2024 22:11:28 +0000 Subject: [PATCH 17/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@3f9d517a7134d73e0f8fe8276c?= =?UTF-8?q?f867cb52e062cd=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/BuildImageDataStack.html | 8 ++++---- classes/BuildImagePipelineStack.html | 4 ++-- classes/BuildImageRepoStack.html | 6 +++--- classes/EmbeddedLinuxPipelineStack.html | 16 ++++++++-------- classes/PipelineNetworkStack.html | 6 +++--- classes/SourceRepo.html | 6 +++--- enums/ImageKind.html | 4 ++-- enums/ProjectKind.html | 14 +++++++------- interfaces/BuildImageDataProps.html | 4 ++-- interfaces/BuildImagePipelineProps.html | 8 ++++---- interfaces/EmbeddedLinuxPipelineProps.html | 14 +++++++------- interfaces/SourceRepoProps.html | 6 +++--- 12 files changed, 48 insertions(+), 48 deletions(-) diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html index 90605a1..365b136 100644 --- a/classes/BuildImageDataStack.html +++ b/classes/BuildImageDataStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:22
    • @@ -116,7 +116,7 @@
    props: Returns BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:26

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:24

    • Readonly tags

    tags: TagManager
    @@ -486,7 +486,7 @@
    bucketName: Returns IBucket
    +
  • Defined in lib/build-image-data.ts:38

    • Static isStack

      diff --git a/classes/BuildImagePipelineStack.html b/classes/BuildImagePipelineStack.html index ccb0f54..54f0ed6 100644 --- a/classes/BuildImagePipelineStack.html +++ b/classes/BuildImagePipelineStack.html @@ -28,7 +28,7 @@

      Hierarchy

      • BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:40
    • @@ -116,7 +116,7 @@
    props: Returns BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:41

    • Properties

    diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html index c6b366c..b484845 100644 --- a/classes/BuildImageRepoStack.html +++ b/classes/BuildImageRepoStack.html @@ -27,7 +27,7 @@

    Hierarchy

    • BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:10
    • @@ -116,7 +116,7 @@
    Optional Returns BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:14

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-repo.ts:12

    • Readonly tags

    tags: TagManager
    diff --git a/classes/EmbeddedLinuxPipelineStack.html b/classes/EmbeddedLinuxPipelineStack.html index cc1a8d8..1afaec9 100644 --- a/classes/EmbeddedLinuxPipelineStack.html +++ b/classes/EmbeddedLinuxPipelineStack.html @@ -27,7 +27,7 @@

    Hierarchy

    • EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:60
    • @@ -121,7 +121,7 @@
    props: Returns EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:61

    • Properties

    @@ -494,7 +494,7 @@

    Returns string

    +
  • Defined in lib/embedded-linux-pipeline.ts:344

    • Private addVMExportPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:361

    • Private addAMIS3BackupPolicy

      @@ -515,7 +515,7 @@

      Parameters

      artifactBucketArn: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:376

    • Private addAMIEBSBackupPolicy

      @@ -528,7 +528,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:388

    • Private addAMIBackupPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:401

    • Private addAMIEC2EBSBackupPolicy

      @@ -549,7 +549,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:408

    • Static isStack

      diff --git a/classes/PipelineNetworkStack.html b/classes/PipelineNetworkStack.html index a84133d..a159820 100644 --- a/classes/PipelineNetworkStack.html +++ b/classes/PipelineNetworkStack.html @@ -28,7 +28,7 @@

      Hierarchy

      • PipelineNetworkStack
    +
  • Defined in lib/network.ts:12
    • @@ -115,7 +115,7 @@
    Optional Returns PipelineNetworkStack
    +
  • Defined in lib/network.ts:16

    • Properties

    @@ -125,7 +125,7 @@

    Readonly

    +
  • Defined in lib/network.ts:14

    • Readonly tags

    tags: TagManager
    diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html index 8982086..d793b58 100644 --- a/classes/SourceRepo.html +++ b/classes/SourceRepo.html @@ -28,7 +28,7 @@

    Hierarchy

    • SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:38
    • @@ -67,7 +67,7 @@
    props: Returns SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:42

    • Properties

    @@ -77,7 +77,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:40

    • Readonly node

    node: Node
    diff --git a/enums/ImageKind.html b/enums/ImageKind.html index 682fbb6..fc7e29a 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -20,7 +20,7 @@

    Enumeration ImageKind

    +
  • Defined in lib/build-image-pipeline.ts:17
    • @@ -39,7 +39,7 @@

    Ubuntu22_04

    +
  • Defined in lib/build-image-pipeline.ts:19
    • diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html index a6d3752..6fabd40 100644 --- a/enums/ProjectKind.html +++ b/enums/ProjectKind.html @@ -20,7 +20,7 @@

    Enumeration ProjectKind

    +
  • Defined in lib/constructs/source-repo.ts:10
    • @@ -44,7 +44,7 @@

    Poky

    +
  • Defined in lib/constructs/source-repo.ts:12

    • MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"
    @@ -52,7 +52,7 @@

    MetaAwsDemo

    +
  • Defined in lib/constructs/source-repo.ts:14

    • PokyAmi

    PokyAmi: "poky-ami"
    @@ -60,7 +60,7 @@

    PokyAmi

    +
  • Defined in lib/constructs/source-repo.ts:16

    • Kas

    Kas: "kas"
    @@ -68,7 +68,7 @@

    Kas

    +
  • Defined in lib/constructs/source-repo.ts:18

    • Renesas

    Renesas: "renesas"
    @@ -76,7 +76,7 @@

    Renesas

    +
  • Defined in lib/constructs/source-repo.ts:20

    • NxpImx

    NxpImx: "nxp-imx"
    @@ -84,7 +84,7 @@

    NxpImx

    +
  • Defined in lib/constructs/source-repo.ts:22
    • diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html index da7e455..c67a007 100644 --- a/interfaces/BuildImageDataProps.html +++ b/interfaces/BuildImageDataProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataProps
    +
  • Defined in lib/build-image-data.ts:14
    • @@ -55,7 +55,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:16

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/BuildImagePipelineProps.html b/interfaces/BuildImagePipelineProps.html index 7cada41..2d69a06 100644 --- a/interfaces/BuildImagePipelineProps.html +++ b/interfaces/BuildImagePipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImagePipelineProps
    +
  • Defined in lib/build-image-pipeline.ts:25
    • @@ -57,7 +57,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:27

    • Readonly dataBucket

    dataBucket: IBucket
    @@ -65,7 +65,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:29

    • Readonly repository

    repository: IRepository
    @@ -73,7 +73,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:31

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/EmbeddedLinuxPipelineProps.html b/interfaces/EmbeddedLinuxPipelineProps.html index e9b0604..d2d84ce 100644 --- a/interfaces/EmbeddedLinuxPipelineProps.html +++ b/interfaces/EmbeddedLinuxPipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • EmbeddedLinuxPipelineProps
    +
  • Defined in lib/embedded-linux-pipeline.ts:40
    • @@ -60,7 +60,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:42

    • Optional Readonly imageTag

    imageTag?: string
    @@ -68,7 +68,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:44

    • Readonly vpc

    vpc: IVpc
    @@ -76,7 +76,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:46

    • Optional Readonly projectKind

    projectKind?: ProjectKind
    @@ -84,7 +84,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:48

    • Optional Readonly layerRepoName

    layerRepoName?: string
    @@ -92,7 +92,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:50

    • Optional Readonly buildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]
    @@ -100,7 +100,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:52

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html index 36224ee..e87302d 100644 --- a/interfaces/SourceRepoProps.html +++ b/interfaces/SourceRepoProps.html @@ -22,7 +22,7 @@

    Hierarchy

    • SourceRepoProps
    +
  • Defined in lib/constructs/source-repo.ts:25
    • @@ -52,7 +52,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:27

    • Readonly kind

    kind: ProjectKind
    @@ -60,7 +60,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:29

    • Optional Readonly description

    description?: string
    From 81eb2082ff9a9d723979bcb5a59c530fb5a5a26c Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 15 Oct 2024 05:22:53 +0000 Subject: [PATCH 18/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@0d4acaaa9136e53e3ff71efb14?= =?UTF-8?q?8797bb5a22ceb7=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- assets/search.js | 2 +- classes/BuildImageDataStack.html | 8 +-- classes/BuildImagePipelineStack.html | 4 +- classes/BuildImageRepoStack.html | 6 +- classes/EmbeddedLinuxPipelineStack.html | 16 +++--- classes/PipelineNetworkStack.html | 6 +- classes/SourceRepo.html | 6 +- enums/ImageKind.html | 4 +- enums/ProjectKind.html | 14 ++--- interfaces/BuildImageDataProps.html | 4 +- interfaces/BuildImagePipelineProps.html | 38 +++++++++++-- interfaces/EmbeddedLinuxPipelineProps.html | 64 +++++++++++++++++++--- interfaces/SourceRepoProps.html | 6 +- 13 files changed, 129 insertions(+), 49 deletions(-) diff --git a/assets/search.js b/assets/search.js index fd24389..7c384dc 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"rows\":[{\"kind\":128,\"name\":\"PipelineNetworkStack\",\"url\":\"classes/PipelineNetworkStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/PipelineNetworkStack.html#constructor\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"classes/PipelineNetworkStack.html#vpc\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":256,\"name\":\"BuildImageDataProps\",\"url\":\"interfaces/BuildImageDataProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"bucketName\",\"url\":\"interfaces/BuildImageDataProps.html#bucketName\",\"classes\":\"\",\"parent\":\"BuildImageDataProps\"},{\"kind\":128,\"name\":\"BuildImageDataStack\",\"url\":\"classes/BuildImageDataStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageDataStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":1024,\"name\":\"bucket\",\"url\":\"classes/BuildImageDataStack.html#bucket\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":2048,\"name\":\"createDeploymentBucket\",\"url\":\"classes/BuildImageDataStack.html#createDeploymentBucket\",\"classes\":\"tsd-is-private\",\"parent\":\"BuildImageDataStack\"},{\"kind\":128,\"name\":\"BuildImageRepoStack\",\"url\":\"classes/BuildImageRepoStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageRepoStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"classes/BuildImageRepoStack.html#repository\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":8,\"name\":\"ImageKind\",\"url\":\"enums/ImageKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Ubuntu22_04\",\"url\":\"enums/ImageKind.html#Ubuntu22_04\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":256,\"name\":\"BuildImagePipelineProps\",\"url\":\"interfaces/BuildImagePipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageKind\",\"url\":\"interfaces/BuildImagePipelineProps.html#imageKind\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"dataBucket\",\"url\":\"interfaces/BuildImagePipelineProps.html#dataBucket\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"interfaces/BuildImagePipelineProps.html#repository\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":128,\"name\":\"BuildImagePipelineStack\",\"url\":\"classes/BuildImagePipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImagePipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImagePipelineStack\"},{\"kind\":256,\"name\":\"EmbeddedLinuxPipelineProps\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageRepo\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#imageRepo\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"imageTag\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#imageTag\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#vpc\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"projectKind\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#projectKind\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"layerRepoName\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#layerRepoName\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"buildPolicyAdditions\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#buildPolicyAdditions\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":128,\"name\":\"EmbeddedLinuxPipelineStack\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addFileSystem\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addFileSystem\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addVMExportPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addVMExportPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIS3BackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIS3BackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEBSBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIEBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEC2EBSBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIEC2EBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":8,\"name\":\"ProjectKind\",\"url\":\"enums/ProjectKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Poky\",\"url\":\"enums/ProjectKind.html#Poky\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"MetaAwsDemo\",\"url\":\"enums/ProjectKind.html#MetaAwsDemo\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"PokyAmi\",\"url\":\"enums/ProjectKind.html#PokyAmi\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Kas\",\"url\":\"enums/ProjectKind.html#Kas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Renesas\",\"url\":\"enums/ProjectKind.html#Renesas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"NxpImx\",\"url\":\"enums/ProjectKind.html#NxpImx\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":256,\"name\":\"SourceRepoProps\",\"url\":\"interfaces/SourceRepoProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"repoName\",\"url\":\"interfaces/SourceRepoProps.html#repoName\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":1024,\"name\":\"kind\",\"url\":\"interfaces/SourceRepoProps.html#kind\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":128,\"name\":\"SourceRepo\",\"url\":\"classes/SourceRepo.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/SourceRepo.html#constructor\",\"classes\":\"\",\"parent\":\"SourceRepo\"},{\"kind\":1024,\"name\":\"repo\",\"url\":\"classes/SourceRepo.html#repo\",\"classes\":\"\",\"parent\":\"SourceRepo\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,34.864]],[\"comment/0\",[]],[\"name/1\",[1,20.2]],[\"comment/1\",[]],[\"name/2\",[2,29.755]],[\"comment/2\",[]],[\"name/3\",[3,34.864]],[\"comment/3\",[]],[\"name/4\",[4,34.864]],[\"comment/4\",[]],[\"name/5\",[5,34.864]],[\"comment/5\",[]],[\"name/6\",[1,20.2]],[\"comment/6\",[]],[\"name/7\",[6,34.864]],[\"comment/7\",[]],[\"name/8\",[7,34.864]],[\"comment/8\",[]],[\"name/9\",[8,34.864]],[\"comment/9\",[]],[\"name/10\",[1,20.2]],[\"comment/10\",[]],[\"name/11\",[9,29.755]],[\"comment/11\",[]],[\"name/12\",[10,29.755]],[\"comment/12\",[]],[\"name/13\",[11,34.864]],[\"comment/13\",[]],[\"name/14\",[12,34.864]],[\"comment/14\",[]],[\"name/15\",[10,29.755]],[\"comment/15\",[]],[\"name/16\",[13,34.864]],[\"comment/16\",[]],[\"name/17\",[9,29.755]],[\"comment/17\",[]],[\"name/18\",[14,34.864]],[\"comment/18\",[]],[\"name/19\",[1,20.2]],[\"comment/19\",[]],[\"name/20\",[15,34.864]],[\"comment/20\",[]],[\"name/21\",[16,34.864]],[\"comment/21\",[]],[\"name/22\",[17,34.864]],[\"comment/22\",[]],[\"name/23\",[2,29.755]],[\"comment/23\",[]],[\"name/24\",[18,29.755]],[\"comment/24\",[]],[\"name/25\",[19,34.864]],[\"comment/25\",[]],[\"name/26\",[20,34.864]],[\"comment/26\",[]],[\"name/27\",[21,34.864]],[\"comment/27\",[]],[\"name/28\",[1,20.2]],[\"comment/28\",[]],[\"name/29\",[22,34.864]],[\"comment/29\",[]],[\"name/30\",[23,34.864]],[\"comment/30\",[]],[\"name/31\",[24,34.864]],[\"comment/31\",[]],[\"name/32\",[25,34.864]],[\"comment/32\",[]],[\"name/33\",[26,34.864]],[\"comment/33\",[]],[\"name/34\",[27,34.864]],[\"comment/34\",[]],[\"name/35\",[18,29.755]],[\"comment/35\",[]],[\"name/36\",[28,34.864]],[\"comment/36\",[]],[\"name/37\",[29,34.864]],[\"comment/37\",[]],[\"name/38\",[30,34.864]],[\"comment/38\",[]],[\"name/39\",[31,34.864]],[\"comment/39\",[]],[\"name/40\",[32,34.864]],[\"comment/40\",[]],[\"name/41\",[33,34.864]],[\"comment/41\",[]],[\"name/42\",[34,34.864]],[\"comment/42\",[]],[\"name/43\",[35,34.864]],[\"comment/43\",[]],[\"name/44\",[36,34.864]],[\"comment/44\",[]],[\"name/45\",[37,34.864]],[\"comment/45\",[]],[\"name/46\",[1,20.2]],[\"comment/46\",[]],[\"name/47\",[38,34.864]],[\"comment/47\",[]]],\"invertedIndex\":[[\"addamibackuppolicy\",{\"_index\":26,\"name\":{\"33\":{}},\"comment\":{}}],[\"addamiebsbackuppolicy\",{\"_index\":25,\"name\":{\"32\":{}},\"comment\":{}}],[\"addamiec2ebsbackuppolicy\",{\"_index\":27,\"name\":{\"34\":{}},\"comment\":{}}],[\"addamis3backuppolicy\",{\"_index\":24,\"name\":{\"31\":{}},\"comment\":{}}],[\"addfilesystem\",{\"_index\":22,\"name\":{\"29\":{}},\"comment\":{}}],[\"addvmexportpolicy\",{\"_index\":23,\"name\":{\"30\":{}},\"comment\":{}}],[\"bucket\",{\"_index\":6,\"name\":{\"7\":{}},\"comment\":{}}],[\"bucketname\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"buildimagedataprops\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"buildimagedatastack\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"buildimagepipelineprops\",{\"_index\":12,\"name\":{\"14\":{}},\"comment\":{}}],[\"buildimagepipelinestack\",{\"_index\":14,\"name\":{\"18\":{}},\"comment\":{}}],[\"buildimagerepostack\",{\"_index\":8,\"name\":{\"9\":{}},\"comment\":{}}],[\"buildpolicyadditions\",{\"_index\":20,\"name\":{\"26\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{},\"6\":{},\"10\":{},\"19\":{},\"28\":{},\"46\":{}},\"comment\":{}}],[\"createdeploymentbucket\",{\"_index\":7,\"name\":{\"8\":{}},\"comment\":{}}],[\"databucket\",{\"_index\":13,\"name\":{\"16\":{}},\"comment\":{}}],[\"embeddedlinuxpipelineprops\",{\"_index\":15,\"name\":{\"20\":{}},\"comment\":{}}],[\"embeddedlinuxpipelinestack\",{\"_index\":21,\"name\":{\"27\":{}},\"comment\":{}}],[\"imagekind\",{\"_index\":10,\"name\":{\"12\":{},\"15\":{}},\"comment\":{}}],[\"imagerepo\",{\"_index\":16,\"name\":{\"21\":{}},\"comment\":{}}],[\"imagetag\",{\"_index\":17,\"name\":{\"22\":{}},\"comment\":{}}],[\"kas\",{\"_index\":31,\"name\":{\"39\":{}},\"comment\":{}}],[\"kind\",{\"_index\":36,\"name\":{\"44\":{}},\"comment\":{}}],[\"layerreponame\",{\"_index\":19,\"name\":{\"25\":{}},\"comment\":{}}],[\"metaawsdemo\",{\"_index\":29,\"name\":{\"37\":{}},\"comment\":{}}],[\"nxpimx\",{\"_index\":33,\"name\":{\"41\":{}},\"comment\":{}}],[\"pipelinenetworkstack\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"poky\",{\"_index\":28,\"name\":{\"36\":{}},\"comment\":{}}],[\"pokyami\",{\"_index\":30,\"name\":{\"38\":{}},\"comment\":{}}],[\"projectkind\",{\"_index\":18,\"name\":{\"24\":{},\"35\":{}},\"comment\":{}}],[\"renesas\",{\"_index\":32,\"name\":{\"40\":{}},\"comment\":{}}],[\"repo\",{\"_index\":38,\"name\":{\"47\":{}},\"comment\":{}}],[\"reponame\",{\"_index\":35,\"name\":{\"43\":{}},\"comment\":{}}],[\"repository\",{\"_index\":9,\"name\":{\"11\":{},\"17\":{}},\"comment\":{}}],[\"sourcerepo\",{\"_index\":37,\"name\":{\"45\":{}},\"comment\":{}}],[\"sourcerepoprops\",{\"_index\":34,\"name\":{\"42\":{}},\"comment\":{}}],[\"ubuntu22_04\",{\"_index\":11,\"name\":{\"13\":{}},\"comment\":{}}],[\"vpc\",{\"_index\":2,\"name\":{\"2\":{},\"23\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = JSON.parse("{\"rows\":[{\"kind\":128,\"name\":\"PipelineNetworkStack\",\"url\":\"classes/PipelineNetworkStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/PipelineNetworkStack.html#constructor\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"classes/PipelineNetworkStack.html#vpc\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":256,\"name\":\"BuildImageDataProps\",\"url\":\"interfaces/BuildImageDataProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"bucketName\",\"url\":\"interfaces/BuildImageDataProps.html#bucketName\",\"classes\":\"\",\"parent\":\"BuildImageDataProps\"},{\"kind\":128,\"name\":\"BuildImageDataStack\",\"url\":\"classes/BuildImageDataStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageDataStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":1024,\"name\":\"bucket\",\"url\":\"classes/BuildImageDataStack.html#bucket\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":2048,\"name\":\"createDeploymentBucket\",\"url\":\"classes/BuildImageDataStack.html#createDeploymentBucket\",\"classes\":\"tsd-is-private\",\"parent\":\"BuildImageDataStack\"},{\"kind\":128,\"name\":\"BuildImageRepoStack\",\"url\":\"classes/BuildImageRepoStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageRepoStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"classes/BuildImageRepoStack.html#repository\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":8,\"name\":\"ImageKind\",\"url\":\"enums/ImageKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Ubuntu22_04\",\"url\":\"enums/ImageKind.html#Ubuntu22_04\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":256,\"name\":\"BuildImagePipelineProps\",\"url\":\"interfaces/BuildImagePipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageKind\",\"url\":\"interfaces/BuildImagePipelineProps.html#imageKind\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"dataBucket\",\"url\":\"interfaces/BuildImagePipelineProps.html#dataBucket\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"interfaces/BuildImagePipelineProps.html#repository\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"accessLoggingBucket\",\"url\":\"interfaces/BuildImagePipelineProps.html#accessLoggingBucket\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"serverAccessLogsPrefix\",\"url\":\"interfaces/BuildImagePipelineProps.html#serverAccessLogsPrefix\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"artifactBucket\",\"url\":\"interfaces/BuildImagePipelineProps.html#artifactBucket\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":128,\"name\":\"BuildImagePipelineStack\",\"url\":\"classes/BuildImagePipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImagePipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImagePipelineStack\"},{\"kind\":256,\"name\":\"EmbeddedLinuxPipelineProps\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageRepo\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#imageRepo\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"imageTag\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#imageTag\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#vpc\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"projectKind\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#projectKind\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"layerRepoName\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#layerRepoName\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"buildPolicyAdditions\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#buildPolicyAdditions\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"accessLoggingBucket\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#accessLoggingBucket\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"serverAccessLogsPrefix\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#serverAccessLogsPrefix\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"artifactBucket\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#artifactBucket\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"outputBucket\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#outputBucket\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"subDirectoryName\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#subDirectoryName\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":128,\"name\":\"EmbeddedLinuxPipelineStack\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addFileSystem\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addFileSystem\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addVMExportPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addVMExportPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIS3BackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIS3BackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEBSBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIEBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEC2EBSBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIEC2EBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":8,\"name\":\"ProjectKind\",\"url\":\"enums/ProjectKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Poky\",\"url\":\"enums/ProjectKind.html#Poky\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"MetaAwsDemo\",\"url\":\"enums/ProjectKind.html#MetaAwsDemo\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"PokyAmi\",\"url\":\"enums/ProjectKind.html#PokyAmi\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Kas\",\"url\":\"enums/ProjectKind.html#Kas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Renesas\",\"url\":\"enums/ProjectKind.html#Renesas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"NxpImx\",\"url\":\"enums/ProjectKind.html#NxpImx\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":256,\"name\":\"SourceRepoProps\",\"url\":\"interfaces/SourceRepoProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"repoName\",\"url\":\"interfaces/SourceRepoProps.html#repoName\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":1024,\"name\":\"kind\",\"url\":\"interfaces/SourceRepoProps.html#kind\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":128,\"name\":\"SourceRepo\",\"url\":\"classes/SourceRepo.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/SourceRepo.html#constructor\",\"classes\":\"\",\"parent\":\"SourceRepo\"},{\"kind\":1024,\"name\":\"repo\",\"url\":\"classes/SourceRepo.html#repo\",\"classes\":\"\",\"parent\":\"SourceRepo\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,36.376]],[\"comment/0\",[]],[\"name/1\",[1,21.712]],[\"comment/1\",[]],[\"name/2\",[2,31.268]],[\"comment/2\",[]],[\"name/3\",[3,36.376]],[\"comment/3\",[]],[\"name/4\",[4,36.376]],[\"comment/4\",[]],[\"name/5\",[5,36.376]],[\"comment/5\",[]],[\"name/6\",[1,21.712]],[\"comment/6\",[]],[\"name/7\",[6,36.376]],[\"comment/7\",[]],[\"name/8\",[7,36.376]],[\"comment/8\",[]],[\"name/9\",[8,36.376]],[\"comment/9\",[]],[\"name/10\",[1,21.712]],[\"comment/10\",[]],[\"name/11\",[9,31.268]],[\"comment/11\",[]],[\"name/12\",[10,31.268]],[\"comment/12\",[]],[\"name/13\",[11,36.376]],[\"comment/13\",[]],[\"name/14\",[12,36.376]],[\"comment/14\",[]],[\"name/15\",[10,31.268]],[\"comment/15\",[]],[\"name/16\",[13,36.376]],[\"comment/16\",[]],[\"name/17\",[9,31.268]],[\"comment/17\",[]],[\"name/18\",[14,31.268]],[\"comment/18\",[]],[\"name/19\",[15,31.268]],[\"comment/19\",[]],[\"name/20\",[16,31.268]],[\"comment/20\",[]],[\"name/21\",[17,36.376]],[\"comment/21\",[]],[\"name/22\",[1,21.712]],[\"comment/22\",[]],[\"name/23\",[18,36.376]],[\"comment/23\",[]],[\"name/24\",[19,36.376]],[\"comment/24\",[]],[\"name/25\",[20,36.376]],[\"comment/25\",[]],[\"name/26\",[2,31.268]],[\"comment/26\",[]],[\"name/27\",[21,31.268]],[\"comment/27\",[]],[\"name/28\",[22,36.376]],[\"comment/28\",[]],[\"name/29\",[23,36.376]],[\"comment/29\",[]],[\"name/30\",[14,31.268]],[\"comment/30\",[]],[\"name/31\",[15,31.268]],[\"comment/31\",[]],[\"name/32\",[16,31.268]],[\"comment/32\",[]],[\"name/33\",[24,36.376]],[\"comment/33\",[]],[\"name/34\",[25,36.376]],[\"comment/34\",[]],[\"name/35\",[26,36.376]],[\"comment/35\",[]],[\"name/36\",[1,21.712]],[\"comment/36\",[]],[\"name/37\",[27,36.376]],[\"comment/37\",[]],[\"name/38\",[28,36.376]],[\"comment/38\",[]],[\"name/39\",[29,36.376]],[\"comment/39\",[]],[\"name/40\",[30,36.376]],[\"comment/40\",[]],[\"name/41\",[31,36.376]],[\"comment/41\",[]],[\"name/42\",[32,36.376]],[\"comment/42\",[]],[\"name/43\",[21,31.268]],[\"comment/43\",[]],[\"name/44\",[33,36.376]],[\"comment/44\",[]],[\"name/45\",[34,36.376]],[\"comment/45\",[]],[\"name/46\",[35,36.376]],[\"comment/46\",[]],[\"name/47\",[36,36.376]],[\"comment/47\",[]],[\"name/48\",[37,36.376]],[\"comment/48\",[]],[\"name/49\",[38,36.376]],[\"comment/49\",[]],[\"name/50\",[39,36.376]],[\"comment/50\",[]],[\"name/51\",[40,36.376]],[\"comment/51\",[]],[\"name/52\",[41,36.376]],[\"comment/52\",[]],[\"name/53\",[42,36.376]],[\"comment/53\",[]],[\"name/54\",[1,21.712]],[\"comment/54\",[]],[\"name/55\",[43,36.376]],[\"comment/55\",[]]],\"invertedIndex\":[[\"accessloggingbucket\",{\"_index\":14,\"name\":{\"18\":{},\"30\":{}},\"comment\":{}}],[\"addamibackuppolicy\",{\"_index\":31,\"name\":{\"41\":{}},\"comment\":{}}],[\"addamiebsbackuppolicy\",{\"_index\":30,\"name\":{\"40\":{}},\"comment\":{}}],[\"addamiec2ebsbackuppolicy\",{\"_index\":32,\"name\":{\"42\":{}},\"comment\":{}}],[\"addamis3backuppolicy\",{\"_index\":29,\"name\":{\"39\":{}},\"comment\":{}}],[\"addfilesystem\",{\"_index\":27,\"name\":{\"37\":{}},\"comment\":{}}],[\"addvmexportpolicy\",{\"_index\":28,\"name\":{\"38\":{}},\"comment\":{}}],[\"artifactbucket\",{\"_index\":16,\"name\":{\"20\":{},\"32\":{}},\"comment\":{}}],[\"bucket\",{\"_index\":6,\"name\":{\"7\":{}},\"comment\":{}}],[\"bucketname\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"buildimagedataprops\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"buildimagedatastack\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"buildimagepipelineprops\",{\"_index\":12,\"name\":{\"14\":{}},\"comment\":{}}],[\"buildimagepipelinestack\",{\"_index\":17,\"name\":{\"21\":{}},\"comment\":{}}],[\"buildimagerepostack\",{\"_index\":8,\"name\":{\"9\":{}},\"comment\":{}}],[\"buildpolicyadditions\",{\"_index\":23,\"name\":{\"29\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{},\"6\":{},\"10\":{},\"22\":{},\"36\":{},\"54\":{}},\"comment\":{}}],[\"createdeploymentbucket\",{\"_index\":7,\"name\":{\"8\":{}},\"comment\":{}}],[\"databucket\",{\"_index\":13,\"name\":{\"16\":{}},\"comment\":{}}],[\"embeddedlinuxpipelineprops\",{\"_index\":18,\"name\":{\"23\":{}},\"comment\":{}}],[\"embeddedlinuxpipelinestack\",{\"_index\":26,\"name\":{\"35\":{}},\"comment\":{}}],[\"imagekind\",{\"_index\":10,\"name\":{\"12\":{},\"15\":{}},\"comment\":{}}],[\"imagerepo\",{\"_index\":19,\"name\":{\"24\":{}},\"comment\":{}}],[\"imagetag\",{\"_index\":20,\"name\":{\"25\":{}},\"comment\":{}}],[\"kas\",{\"_index\":36,\"name\":{\"47\":{}},\"comment\":{}}],[\"kind\",{\"_index\":41,\"name\":{\"52\":{}},\"comment\":{}}],[\"layerreponame\",{\"_index\":22,\"name\":{\"28\":{}},\"comment\":{}}],[\"metaawsdemo\",{\"_index\":34,\"name\":{\"45\":{}},\"comment\":{}}],[\"nxpimx\",{\"_index\":38,\"name\":{\"49\":{}},\"comment\":{}}],[\"outputbucket\",{\"_index\":24,\"name\":{\"33\":{}},\"comment\":{}}],[\"pipelinenetworkstack\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"poky\",{\"_index\":33,\"name\":{\"44\":{}},\"comment\":{}}],[\"pokyami\",{\"_index\":35,\"name\":{\"46\":{}},\"comment\":{}}],[\"projectkind\",{\"_index\":21,\"name\":{\"27\":{},\"43\":{}},\"comment\":{}}],[\"renesas\",{\"_index\":37,\"name\":{\"48\":{}},\"comment\":{}}],[\"repo\",{\"_index\":43,\"name\":{\"55\":{}},\"comment\":{}}],[\"reponame\",{\"_index\":40,\"name\":{\"51\":{}},\"comment\":{}}],[\"repository\",{\"_index\":9,\"name\":{\"11\":{},\"17\":{}},\"comment\":{}}],[\"serveraccesslogsprefix\",{\"_index\":15,\"name\":{\"19\":{},\"31\":{}},\"comment\":{}}],[\"sourcerepo\",{\"_index\":42,\"name\":{\"53\":{}},\"comment\":{}}],[\"sourcerepoprops\",{\"_index\":39,\"name\":{\"50\":{}},\"comment\":{}}],[\"subdirectoryname\",{\"_index\":25,\"name\":{\"34\":{}},\"comment\":{}}],[\"ubuntu22_04\",{\"_index\":11,\"name\":{\"13\":{}},\"comment\":{}}],[\"vpc\",{\"_index\":2,\"name\":{\"2\":{},\"26\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html index 365b136..faa7a17 100644 --- a/classes/BuildImageDataStack.html +++ b/classes/BuildImageDataStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:22
    • @@ -116,7 +116,7 @@
    props: Returns BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:26

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:24

    • Readonly tags

    tags: TagManager
    @@ -486,7 +486,7 @@
    bucketName: Returns IBucket
    +
  • Defined in lib/build-image-data.ts:38

    • Static isStack

      diff --git a/classes/BuildImagePipelineStack.html b/classes/BuildImagePipelineStack.html index 54f0ed6..a63498b 100644 --- a/classes/BuildImagePipelineStack.html +++ b/classes/BuildImagePipelineStack.html @@ -28,7 +28,7 @@

      Hierarchy

      • BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:47
    • @@ -116,7 +116,7 @@
    props: Returns BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:48

    • Properties

    diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html index b484845..48730ec 100644 --- a/classes/BuildImageRepoStack.html +++ b/classes/BuildImageRepoStack.html @@ -27,7 +27,7 @@

    Hierarchy

    • BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:10
    • @@ -116,7 +116,7 @@
    Optional Returns BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:14

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-repo.ts:12

    • Readonly tags

    tags: TagManager
    diff --git a/classes/EmbeddedLinuxPipelineStack.html b/classes/EmbeddedLinuxPipelineStack.html index 1afaec9..3ac360f 100644 --- a/classes/EmbeddedLinuxPipelineStack.html +++ b/classes/EmbeddedLinuxPipelineStack.html @@ -27,7 +27,7 @@

    Hierarchy

    • EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:70
    • @@ -121,7 +121,7 @@
    props: Returns EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:71

    • Properties

    @@ -494,7 +494,7 @@

    Returns string

    +
  • Defined in lib/embedded-linux-pipeline.ts:384

    • Private addVMExportPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:401

    • Private addAMIS3BackupPolicy

      @@ -515,7 +515,7 @@

      Parameters

      artifactBucketArn: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:416

    • Private addAMIEBSBackupPolicy

      @@ -528,7 +528,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:428

    • Private addAMIBackupPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:441

    • Private addAMIEC2EBSBackupPolicy

      @@ -549,7 +549,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:448

    • Static isStack

      diff --git a/classes/PipelineNetworkStack.html b/classes/PipelineNetworkStack.html index a159820..2859a56 100644 --- a/classes/PipelineNetworkStack.html +++ b/classes/PipelineNetworkStack.html @@ -28,7 +28,7 @@

      Hierarchy

      • PipelineNetworkStack
    +
  • Defined in lib/network.ts:12
    • @@ -115,7 +115,7 @@
    Optional Returns PipelineNetworkStack
    +
  • Defined in lib/network.ts:16

    • Properties

    @@ -125,7 +125,7 @@

    Readonly

    +
  • Defined in lib/network.ts:14

    • Readonly tags

    tags: TagManager
    diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html index d793b58..7a281df 100644 --- a/classes/SourceRepo.html +++ b/classes/SourceRepo.html @@ -28,7 +28,7 @@

    Hierarchy

    • SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:38
    • @@ -67,7 +67,7 @@
    props: Returns SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:42

    • Properties

    @@ -77,7 +77,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:40

    • Readonly node

    node: Node
    diff --git a/enums/ImageKind.html b/enums/ImageKind.html index fc7e29a..fc922b5 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -20,7 +20,7 @@

    Enumeration ImageKind

    +
  • Defined in lib/build-image-pipeline.ts:17
    • @@ -39,7 +39,7 @@

    Ubuntu22_04

    +
  • Defined in lib/build-image-pipeline.ts:19
    • diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html index 6fabd40..3460742 100644 --- a/enums/ProjectKind.html +++ b/enums/ProjectKind.html @@ -20,7 +20,7 @@

    Enumeration ProjectKind

    +
  • Defined in lib/constructs/source-repo.ts:10
    • @@ -44,7 +44,7 @@

    Poky

    +
  • Defined in lib/constructs/source-repo.ts:12

    • MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"
    @@ -52,7 +52,7 @@

    MetaAwsDemo

    +
  • Defined in lib/constructs/source-repo.ts:14

    • PokyAmi

    PokyAmi: "poky-ami"
    @@ -60,7 +60,7 @@

    PokyAmi

    +
  • Defined in lib/constructs/source-repo.ts:16

    • Kas

    Kas: "kas"
    @@ -68,7 +68,7 @@

    Kas

    +
  • Defined in lib/constructs/source-repo.ts:18

    • Renesas

    Renesas: "renesas"
    @@ -76,7 +76,7 @@

    Renesas

    +
  • Defined in lib/constructs/source-repo.ts:20

    • NxpImx

    NxpImx: "nxp-imx"
    @@ -84,7 +84,7 @@

    NxpImx

    +
  • Defined in lib/constructs/source-repo.ts:22
    • diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html index c67a007..b0f3395 100644 --- a/interfaces/BuildImageDataProps.html +++ b/interfaces/BuildImageDataProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataProps
    +
  • Defined in lib/build-image-data.ts:14
    • @@ -55,7 +55,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:16

    • Optional Readonly description

    description?: string
    diff --git a/interfaces/BuildImagePipelineProps.html b/interfaces/BuildImagePipelineProps.html index 2d69a06..4b706e3 100644 --- a/interfaces/BuildImagePipelineProps.html +++ b/interfaces/BuildImagePipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImagePipelineProps
    +
  • Defined in lib/build-image-pipeline.ts:25
    • @@ -37,6 +37,9 @@

    Properties

    imageKind dataBucket repository +accessLoggingBucket? +serverAccessLogsPrefix? +artifactBucket? description? env? stackName? @@ -57,7 +60,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:27

    • Readonly dataBucket

    dataBucket: IBucket
    @@ -65,7 +68,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:29

    • Readonly repository

    repository: IRepository
    @@ -73,7 +76,31 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:31
    • +
    +

    Optional Readonly accessLoggingBucket

    +
    accessLoggingBucket?: Bucket
    +

    Access logging bucket to use

    +
    +
    +
    +

    Optional Readonly serverAccessLogsPrefix

    +
    serverAccessLogsPrefix?: string
    +

    Access logging prefix to use

    +
    +
    +
    +

    Optional Readonly artifactBucket

    +
    artifactBucket?: Bucket
    +

    Artifact bucket to use

    +
    +

    Optional Readonly description

    description?: string
    @@ -260,6 +287,9 @@

    imageKind
  • dataBucket
  • repository
    • +
  • accessLoggingBucket
    • +
  • serverAccessLogsPrefix
    • +
  • artifactBucket
  • description
  • env
  • stackName
    • diff --git a/interfaces/EmbeddedLinuxPipelineProps.html b/interfaces/EmbeddedLinuxPipelineProps.html index d2d84ce..a4e0150 100644 --- a/interfaces/EmbeddedLinuxPipelineProps.html +++ b/interfaces/EmbeddedLinuxPipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • EmbeddedLinuxPipelineProps
    +
  • Defined in lib/embedded-linux-pipeline.ts:40
    • @@ -40,6 +40,11 @@

    Properties

    projectKind? layerRepoName? buildPolicyAdditions? +accessLoggingBucket? +serverAccessLogsPrefix? +artifactBucket? +outputBucket? +subDirectoryName? description? env? stackName? @@ -60,7 +65,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:42

    • Optional Readonly imageTag

    imageTag?: string
    @@ -68,7 +73,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:44

    • Readonly vpc

    vpc: IVpc
    @@ -76,7 +81,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:46

    • Optional Readonly projectKind

    projectKind?: ProjectKind
    @@ -84,7 +89,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:48

    • Optional Readonly layerRepoName

    layerRepoName?: string
    @@ -92,7 +97,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:50

    • Optional Readonly buildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]
    @@ -100,7 +105,47 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:52
    • +
    +

    Optional Readonly accessLoggingBucket

    +
    accessLoggingBucket?: Bucket
    +

    Access logging bucket to use

    +
    +
    +
    +

    Optional Readonly serverAccessLogsPrefix

    +
    serverAccessLogsPrefix?: string
    +

    Access logging prefix to use

    +
    +
    +
    +

    Optional Readonly artifactBucket

    +
    artifactBucket?: Bucket
    +

    Artifact bucket to use

    +
    +
    +
    +

    Optional Readonly outputBucket

    +
    outputBucket?: Bucket | VMImportBucket
    +

    Output bucket to use

    +
    +
    +
    +

    Optional Readonly subDirectoryName

    +
    subDirectoryName?: string
    +

    Prefix for S3 object within bucket

    +
    +

    Optional Readonly description

    description?: string
    @@ -290,6 +335,11 @@

    projectKind
  • layerRepoName
  • buildPolicyAdditions
    • +
  • accessLoggingBucket
    • +
  • serverAccessLogsPrefix
    • +
  • artifactBucket
    • +
  • outputBucket
    • +
  • subDirectoryName
  • description
  • env
  • stackName
    • diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html index e87302d..74b7dc3 100644 --- a/interfaces/SourceRepoProps.html +++ b/interfaces/SourceRepoProps.html @@ -22,7 +22,7 @@

    Hierarchy

    • SourceRepoProps
    +
  • Defined in lib/constructs/source-repo.ts:25
    • @@ -52,7 +52,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:27

    • Readonly kind

    kind: ProjectKind
    @@ -60,7 +60,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:29

    • Optional Readonly description

    description?: string
    From 6e57fb50196631f593725c1af28b94def7cb10b0 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 15 Oct 2024 10:58:43 +0000 Subject: [PATCH 19/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@187a6efad5289209b44241210a?= =?UTF-8?q?8ccd25d180110e=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- assets/search.js | 2 +- classes/BuildImageDataStack.html | 129 +- classes/BuildImagePipelineStack.html | 125 +- classes/BuildImageRepoStack.html | 127 +- .../EmbeddedLinuxCodebuildProjectStack.html | 1221 +++++++++++++++++ classes/EmbeddedLinuxPipelineStack.html | 137 +- classes/PipelineNetworkStack.html | 127 +- classes/SourceRepo.html | 8 +- enums/ImageKind.html | 6 +- enums/ProjectKind.html | 28 +- index.html | 2 + interfaces/BuildImageDataProps.html | 6 +- interfaces/BuildImagePipelineProps.html | 16 +- .../EmbeddedLinuxCodebuildProjectProps.html | 372 +++++ interfaces/EmbeddedLinuxPipelineProps.html | 26 +- interfaces/SourceRepoProps.html | 8 +- modules.html | 4 + 17 files changed, 2006 insertions(+), 338 deletions(-) create mode 100644 classes/EmbeddedLinuxCodebuildProjectStack.html create mode 100644 interfaces/EmbeddedLinuxCodebuildProjectProps.html diff --git a/assets/search.js b/assets/search.js index 7c384dc..8ed1df3 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"rows\":[{\"kind\":128,\"name\":\"PipelineNetworkStack\",\"url\":\"classes/PipelineNetworkStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/PipelineNetworkStack.html#constructor\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"classes/PipelineNetworkStack.html#vpc\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":256,\"name\":\"BuildImageDataProps\",\"url\":\"interfaces/BuildImageDataProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"bucketName\",\"url\":\"interfaces/BuildImageDataProps.html#bucketName\",\"classes\":\"\",\"parent\":\"BuildImageDataProps\"},{\"kind\":128,\"name\":\"BuildImageDataStack\",\"url\":\"classes/BuildImageDataStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageDataStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":1024,\"name\":\"bucket\",\"url\":\"classes/BuildImageDataStack.html#bucket\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":2048,\"name\":\"createDeploymentBucket\",\"url\":\"classes/BuildImageDataStack.html#createDeploymentBucket\",\"classes\":\"tsd-is-private\",\"parent\":\"BuildImageDataStack\"},{\"kind\":128,\"name\":\"BuildImageRepoStack\",\"url\":\"classes/BuildImageRepoStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageRepoStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"classes/BuildImageRepoStack.html#repository\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":8,\"name\":\"ImageKind\",\"url\":\"enums/ImageKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Ubuntu22_04\",\"url\":\"enums/ImageKind.html#Ubuntu22_04\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":256,\"name\":\"BuildImagePipelineProps\",\"url\":\"interfaces/BuildImagePipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageKind\",\"url\":\"interfaces/BuildImagePipelineProps.html#imageKind\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"dataBucket\",\"url\":\"interfaces/BuildImagePipelineProps.html#dataBucket\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"interfaces/BuildImagePipelineProps.html#repository\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"accessLoggingBucket\",\"url\":\"interfaces/BuildImagePipelineProps.html#accessLoggingBucket\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"serverAccessLogsPrefix\",\"url\":\"interfaces/BuildImagePipelineProps.html#serverAccessLogsPrefix\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"artifactBucket\",\"url\":\"interfaces/BuildImagePipelineProps.html#artifactBucket\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":128,\"name\":\"BuildImagePipelineStack\",\"url\":\"classes/BuildImagePipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImagePipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImagePipelineStack\"},{\"kind\":256,\"name\":\"EmbeddedLinuxPipelineProps\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageRepo\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#imageRepo\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"imageTag\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#imageTag\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#vpc\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"projectKind\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#projectKind\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"layerRepoName\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#layerRepoName\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"buildPolicyAdditions\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#buildPolicyAdditions\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"accessLoggingBucket\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#accessLoggingBucket\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"serverAccessLogsPrefix\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#serverAccessLogsPrefix\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"artifactBucket\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#artifactBucket\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"outputBucket\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#outputBucket\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"subDirectoryName\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#subDirectoryName\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":128,\"name\":\"EmbeddedLinuxPipelineStack\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addFileSystem\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addFileSystem\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addVMExportPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addVMExportPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIS3BackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIS3BackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEBSBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIEBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEC2EBSBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIEC2EBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":8,\"name\":\"ProjectKind\",\"url\":\"enums/ProjectKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Poky\",\"url\":\"enums/ProjectKind.html#Poky\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"MetaAwsDemo\",\"url\":\"enums/ProjectKind.html#MetaAwsDemo\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"PokyAmi\",\"url\":\"enums/ProjectKind.html#PokyAmi\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Kas\",\"url\":\"enums/ProjectKind.html#Kas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Renesas\",\"url\":\"enums/ProjectKind.html#Renesas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"NxpImx\",\"url\":\"enums/ProjectKind.html#NxpImx\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":256,\"name\":\"SourceRepoProps\",\"url\":\"interfaces/SourceRepoProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"repoName\",\"url\":\"interfaces/SourceRepoProps.html#repoName\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":1024,\"name\":\"kind\",\"url\":\"interfaces/SourceRepoProps.html#kind\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":128,\"name\":\"SourceRepo\",\"url\":\"classes/SourceRepo.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/SourceRepo.html#constructor\",\"classes\":\"\",\"parent\":\"SourceRepo\"},{\"kind\":1024,\"name\":\"repo\",\"url\":\"classes/SourceRepo.html#repo\",\"classes\":\"\",\"parent\":\"SourceRepo\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,36.376]],[\"comment/0\",[]],[\"name/1\",[1,21.712]],[\"comment/1\",[]],[\"name/2\",[2,31.268]],[\"comment/2\",[]],[\"name/3\",[3,36.376]],[\"comment/3\",[]],[\"name/4\",[4,36.376]],[\"comment/4\",[]],[\"name/5\",[5,36.376]],[\"comment/5\",[]],[\"name/6\",[1,21.712]],[\"comment/6\",[]],[\"name/7\",[6,36.376]],[\"comment/7\",[]],[\"name/8\",[7,36.376]],[\"comment/8\",[]],[\"name/9\",[8,36.376]],[\"comment/9\",[]],[\"name/10\",[1,21.712]],[\"comment/10\",[]],[\"name/11\",[9,31.268]],[\"comment/11\",[]],[\"name/12\",[10,31.268]],[\"comment/12\",[]],[\"name/13\",[11,36.376]],[\"comment/13\",[]],[\"name/14\",[12,36.376]],[\"comment/14\",[]],[\"name/15\",[10,31.268]],[\"comment/15\",[]],[\"name/16\",[13,36.376]],[\"comment/16\",[]],[\"name/17\",[9,31.268]],[\"comment/17\",[]],[\"name/18\",[14,31.268]],[\"comment/18\",[]],[\"name/19\",[15,31.268]],[\"comment/19\",[]],[\"name/20\",[16,31.268]],[\"comment/20\",[]],[\"name/21\",[17,36.376]],[\"comment/21\",[]],[\"name/22\",[1,21.712]],[\"comment/22\",[]],[\"name/23\",[18,36.376]],[\"comment/23\",[]],[\"name/24\",[19,36.376]],[\"comment/24\",[]],[\"name/25\",[20,36.376]],[\"comment/25\",[]],[\"name/26\",[2,31.268]],[\"comment/26\",[]],[\"name/27\",[21,31.268]],[\"comment/27\",[]],[\"name/28\",[22,36.376]],[\"comment/28\",[]],[\"name/29\",[23,36.376]],[\"comment/29\",[]],[\"name/30\",[14,31.268]],[\"comment/30\",[]],[\"name/31\",[15,31.268]],[\"comment/31\",[]],[\"name/32\",[16,31.268]],[\"comment/32\",[]],[\"name/33\",[24,36.376]],[\"comment/33\",[]],[\"name/34\",[25,36.376]],[\"comment/34\",[]],[\"name/35\",[26,36.376]],[\"comment/35\",[]],[\"name/36\",[1,21.712]],[\"comment/36\",[]],[\"name/37\",[27,36.376]],[\"comment/37\",[]],[\"name/38\",[28,36.376]],[\"comment/38\",[]],[\"name/39\",[29,36.376]],[\"comment/39\",[]],[\"name/40\",[30,36.376]],[\"comment/40\",[]],[\"name/41\",[31,36.376]],[\"comment/41\",[]],[\"name/42\",[32,36.376]],[\"comment/42\",[]],[\"name/43\",[21,31.268]],[\"comment/43\",[]],[\"name/44\",[33,36.376]],[\"comment/44\",[]],[\"name/45\",[34,36.376]],[\"comment/45\",[]],[\"name/46\",[35,36.376]],[\"comment/46\",[]],[\"name/47\",[36,36.376]],[\"comment/47\",[]],[\"name/48\",[37,36.376]],[\"comment/48\",[]],[\"name/49\",[38,36.376]],[\"comment/49\",[]],[\"name/50\",[39,36.376]],[\"comment/50\",[]],[\"name/51\",[40,36.376]],[\"comment/51\",[]],[\"name/52\",[41,36.376]],[\"comment/52\",[]],[\"name/53\",[42,36.376]],[\"comment/53\",[]],[\"name/54\",[1,21.712]],[\"comment/54\",[]],[\"name/55\",[43,36.376]],[\"comment/55\",[]]],\"invertedIndex\":[[\"accessloggingbucket\",{\"_index\":14,\"name\":{\"18\":{},\"30\":{}},\"comment\":{}}],[\"addamibackuppolicy\",{\"_index\":31,\"name\":{\"41\":{}},\"comment\":{}}],[\"addamiebsbackuppolicy\",{\"_index\":30,\"name\":{\"40\":{}},\"comment\":{}}],[\"addamiec2ebsbackuppolicy\",{\"_index\":32,\"name\":{\"42\":{}},\"comment\":{}}],[\"addamis3backuppolicy\",{\"_index\":29,\"name\":{\"39\":{}},\"comment\":{}}],[\"addfilesystem\",{\"_index\":27,\"name\":{\"37\":{}},\"comment\":{}}],[\"addvmexportpolicy\",{\"_index\":28,\"name\":{\"38\":{}},\"comment\":{}}],[\"artifactbucket\",{\"_index\":16,\"name\":{\"20\":{},\"32\":{}},\"comment\":{}}],[\"bucket\",{\"_index\":6,\"name\":{\"7\":{}},\"comment\":{}}],[\"bucketname\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"buildimagedataprops\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"buildimagedatastack\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"buildimagepipelineprops\",{\"_index\":12,\"name\":{\"14\":{}},\"comment\":{}}],[\"buildimagepipelinestack\",{\"_index\":17,\"name\":{\"21\":{}},\"comment\":{}}],[\"buildimagerepostack\",{\"_index\":8,\"name\":{\"9\":{}},\"comment\":{}}],[\"buildpolicyadditions\",{\"_index\":23,\"name\":{\"29\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{},\"6\":{},\"10\":{},\"22\":{},\"36\":{},\"54\":{}},\"comment\":{}}],[\"createdeploymentbucket\",{\"_index\":7,\"name\":{\"8\":{}},\"comment\":{}}],[\"databucket\",{\"_index\":13,\"name\":{\"16\":{}},\"comment\":{}}],[\"embeddedlinuxpipelineprops\",{\"_index\":18,\"name\":{\"23\":{}},\"comment\":{}}],[\"embeddedlinuxpipelinestack\",{\"_index\":26,\"name\":{\"35\":{}},\"comment\":{}}],[\"imagekind\",{\"_index\":10,\"name\":{\"12\":{},\"15\":{}},\"comment\":{}}],[\"imagerepo\",{\"_index\":19,\"name\":{\"24\":{}},\"comment\":{}}],[\"imagetag\",{\"_index\":20,\"name\":{\"25\":{}},\"comment\":{}}],[\"kas\",{\"_index\":36,\"name\":{\"47\":{}},\"comment\":{}}],[\"kind\",{\"_index\":41,\"name\":{\"52\":{}},\"comment\":{}}],[\"layerreponame\",{\"_index\":22,\"name\":{\"28\":{}},\"comment\":{}}],[\"metaawsdemo\",{\"_index\":34,\"name\":{\"45\":{}},\"comment\":{}}],[\"nxpimx\",{\"_index\":38,\"name\":{\"49\":{}},\"comment\":{}}],[\"outputbucket\",{\"_index\":24,\"name\":{\"33\":{}},\"comment\":{}}],[\"pipelinenetworkstack\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"poky\",{\"_index\":33,\"name\":{\"44\":{}},\"comment\":{}}],[\"pokyami\",{\"_index\":35,\"name\":{\"46\":{}},\"comment\":{}}],[\"projectkind\",{\"_index\":21,\"name\":{\"27\":{},\"43\":{}},\"comment\":{}}],[\"renesas\",{\"_index\":37,\"name\":{\"48\":{}},\"comment\":{}}],[\"repo\",{\"_index\":43,\"name\":{\"55\":{}},\"comment\":{}}],[\"reponame\",{\"_index\":40,\"name\":{\"51\":{}},\"comment\":{}}],[\"repository\",{\"_index\":9,\"name\":{\"11\":{},\"17\":{}},\"comment\":{}}],[\"serveraccesslogsprefix\",{\"_index\":15,\"name\":{\"19\":{},\"31\":{}},\"comment\":{}}],[\"sourcerepo\",{\"_index\":42,\"name\":{\"53\":{}},\"comment\":{}}],[\"sourcerepoprops\",{\"_index\":39,\"name\":{\"50\":{}},\"comment\":{}}],[\"subdirectoryname\",{\"_index\":25,\"name\":{\"34\":{}},\"comment\":{}}],[\"ubuntu22_04\",{\"_index\":11,\"name\":{\"13\":{}},\"comment\":{}}],[\"vpc\",{\"_index\":2,\"name\":{\"2\":{},\"26\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = JSON.parse("{\"rows\":[{\"kind\":128,\"name\":\"PipelineNetworkStack\",\"url\":\"classes/PipelineNetworkStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/PipelineNetworkStack.html#constructor\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"classes/PipelineNetworkStack.html#vpc\",\"classes\":\"\",\"parent\":\"PipelineNetworkStack\"},{\"kind\":256,\"name\":\"BuildImageDataProps\",\"url\":\"interfaces/BuildImageDataProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"bucketName\",\"url\":\"interfaces/BuildImageDataProps.html#bucketName\",\"classes\":\"\",\"parent\":\"BuildImageDataProps\"},{\"kind\":128,\"name\":\"BuildImageDataStack\",\"url\":\"classes/BuildImageDataStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageDataStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":1024,\"name\":\"bucket\",\"url\":\"classes/BuildImageDataStack.html#bucket\",\"classes\":\"\",\"parent\":\"BuildImageDataStack\"},{\"kind\":2048,\"name\":\"createDeploymentBucket\",\"url\":\"classes/BuildImageDataStack.html#createDeploymentBucket\",\"classes\":\"tsd-is-private\",\"parent\":\"BuildImageDataStack\"},{\"kind\":128,\"name\":\"BuildImageRepoStack\",\"url\":\"classes/BuildImageRepoStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImageRepoStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"classes/BuildImageRepoStack.html#repository\",\"classes\":\"\",\"parent\":\"BuildImageRepoStack\"},{\"kind\":8,\"name\":\"ImageKind\",\"url\":\"enums/ImageKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Ubuntu22_04\",\"url\":\"enums/ImageKind.html#Ubuntu22_04\",\"classes\":\"\",\"parent\":\"ImageKind\"},{\"kind\":256,\"name\":\"BuildImagePipelineProps\",\"url\":\"interfaces/BuildImagePipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageKind\",\"url\":\"interfaces/BuildImagePipelineProps.html#imageKind\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"dataBucket\",\"url\":\"interfaces/BuildImagePipelineProps.html#dataBucket\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"interfaces/BuildImagePipelineProps.html#repository\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"accessLoggingBucket\",\"url\":\"interfaces/BuildImagePipelineProps.html#accessLoggingBucket\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"serverAccessLogsPrefix\",\"url\":\"interfaces/BuildImagePipelineProps.html#serverAccessLogsPrefix\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":1024,\"name\":\"artifactBucket\",\"url\":\"interfaces/BuildImagePipelineProps.html#artifactBucket\",\"classes\":\"\",\"parent\":\"BuildImagePipelineProps\"},{\"kind\":128,\"name\":\"BuildImagePipelineStack\",\"url\":\"classes/BuildImagePipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BuildImagePipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"BuildImagePipelineStack\"},{\"kind\":256,\"name\":\"EmbeddedLinuxPipelineProps\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageRepo\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#imageRepo\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"imageTag\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#imageTag\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#vpc\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"projectKind\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#projectKind\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"layerRepoName\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#layerRepoName\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"buildPolicyAdditions\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#buildPolicyAdditions\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"accessLoggingBucket\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#accessLoggingBucket\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"serverAccessLogsPrefix\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#serverAccessLogsPrefix\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"artifactBucket\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#artifactBucket\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"outputBucket\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#outputBucket\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":1024,\"name\":\"subDirectoryName\",\"url\":\"interfaces/EmbeddedLinuxPipelineProps.html#subDirectoryName\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineProps\"},{\"kind\":128,\"name\":\"EmbeddedLinuxPipelineStack\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#constructor\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addFileSystem\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addFileSystem\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addVMExportPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addVMExportPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIS3BackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIS3BackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEBSBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIEBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":2048,\"name\":\"addAMIEC2EBSBackupPolicy\",\"url\":\"classes/EmbeddedLinuxPipelineStack.html#addAMIEC2EBSBackupPolicy\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxPipelineStack\"},{\"kind\":256,\"name\":\"EmbeddedLinuxCodebuildProjectProps\",\"url\":\"interfaces/EmbeddedLinuxCodebuildProjectProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"imageRepo\",\"url\":\"interfaces/EmbeddedLinuxCodebuildProjectProps.html#imageRepo\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxCodebuildProjectProps\"},{\"kind\":1024,\"name\":\"imageTag\",\"url\":\"interfaces/EmbeddedLinuxCodebuildProjectProps.html#imageTag\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxCodebuildProjectProps\"},{\"kind\":1024,\"name\":\"vpc\",\"url\":\"interfaces/EmbeddedLinuxCodebuildProjectProps.html#vpc\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxCodebuildProjectProps\"},{\"kind\":1024,\"name\":\"projectKind\",\"url\":\"interfaces/EmbeddedLinuxCodebuildProjectProps.html#projectKind\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxCodebuildProjectProps\"},{\"kind\":1024,\"name\":\"layerRepoName\",\"url\":\"interfaces/EmbeddedLinuxCodebuildProjectProps.html#layerRepoName\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxCodebuildProjectProps\"},{\"kind\":1024,\"name\":\"buildPolicyAdditions\",\"url\":\"interfaces/EmbeddedLinuxCodebuildProjectProps.html#buildPolicyAdditions\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxCodebuildProjectProps\"},{\"kind\":1024,\"name\":\"accessLoggingBucket\",\"url\":\"interfaces/EmbeddedLinuxCodebuildProjectProps.html#accessLoggingBucket\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxCodebuildProjectProps\"},{\"kind\":1024,\"name\":\"serverAccessLogsPrefix\",\"url\":\"interfaces/EmbeddedLinuxCodebuildProjectProps.html#serverAccessLogsPrefix\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxCodebuildProjectProps\"},{\"kind\":1024,\"name\":\"artifactBucket\",\"url\":\"interfaces/EmbeddedLinuxCodebuildProjectProps.html#artifactBucket\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxCodebuildProjectProps\"},{\"kind\":1024,\"name\":\"outputBucket\",\"url\":\"interfaces/EmbeddedLinuxCodebuildProjectProps.html#outputBucket\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxCodebuildProjectProps\"},{\"kind\":1024,\"name\":\"subDirectoryName\",\"url\":\"interfaces/EmbeddedLinuxCodebuildProjectProps.html#subDirectoryName\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxCodebuildProjectProps\"},{\"kind\":128,\"name\":\"EmbeddedLinuxCodebuildProjectStack\",\"url\":\"classes/EmbeddedLinuxCodebuildProjectStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/EmbeddedLinuxCodebuildProjectStack.html#constructor\",\"classes\":\"\",\"parent\":\"EmbeddedLinuxCodebuildProjectStack\"},{\"kind\":2048,\"name\":\"addFileSystem\",\"url\":\"classes/EmbeddedLinuxCodebuildProjectStack.html#addFileSystem\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxCodebuildProjectStack\"},{\"kind\":2048,\"name\":\"addProjectPolicies\",\"url\":\"classes/EmbeddedLinuxCodebuildProjectStack.html#addProjectPolicies\",\"classes\":\"tsd-is-private\",\"parent\":\"EmbeddedLinuxCodebuildProjectStack\"},{\"kind\":8,\"name\":\"ProjectKind\",\"url\":\"enums/ProjectKind.html\",\"classes\":\"\"},{\"kind\":16,\"name\":\"Poky\",\"url\":\"enums/ProjectKind.html#Poky\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"MetaAwsDemo\",\"url\":\"enums/ProjectKind.html#MetaAwsDemo\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"PokyAmi\",\"url\":\"enums/ProjectKind.html#PokyAmi\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Kas\",\"url\":\"enums/ProjectKind.html#Kas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"Renesas\",\"url\":\"enums/ProjectKind.html#Renesas\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"NxpImx\",\"url\":\"enums/ProjectKind.html#NxpImx\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":16,\"name\":\"CodeBuild\",\"url\":\"enums/ProjectKind.html#CodeBuild\",\"classes\":\"\",\"parent\":\"ProjectKind\"},{\"kind\":256,\"name\":\"SourceRepoProps\",\"url\":\"interfaces/SourceRepoProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"repoName\",\"url\":\"interfaces/SourceRepoProps.html#repoName\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":1024,\"name\":\"kind\",\"url\":\"interfaces/SourceRepoProps.html#kind\",\"classes\":\"\",\"parent\":\"SourceRepoProps\"},{\"kind\":128,\"name\":\"SourceRepo\",\"url\":\"classes/SourceRepo.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/SourceRepo.html#constructor\",\"classes\":\"\",\"parent\":\"SourceRepo\"},{\"kind\":1024,\"name\":\"repo\",\"url\":\"classes/SourceRepo.html#repo\",\"classes\":\"\",\"parent\":\"SourceRepo\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,38.986]],[\"comment/0\",[]],[\"name/1\",[1,22.892]],[\"comment/1\",[]],[\"name/2\",[2,30.513]],[\"comment/2\",[]],[\"name/3\",[3,38.986]],[\"comment/3\",[]],[\"name/4\",[4,38.986]],[\"comment/4\",[]],[\"name/5\",[5,38.986]],[\"comment/5\",[]],[\"name/6\",[1,22.892]],[\"comment/6\",[]],[\"name/7\",[6,38.986]],[\"comment/7\",[]],[\"name/8\",[7,38.986]],[\"comment/8\",[]],[\"name/9\",[8,38.986]],[\"comment/9\",[]],[\"name/10\",[1,22.892]],[\"comment/10\",[]],[\"name/11\",[9,33.878]],[\"comment/11\",[]],[\"name/12\",[10,33.878]],[\"comment/12\",[]],[\"name/13\",[11,38.986]],[\"comment/13\",[]],[\"name/14\",[12,38.986]],[\"comment/14\",[]],[\"name/15\",[10,33.878]],[\"comment/15\",[]],[\"name/16\",[13,38.986]],[\"comment/16\",[]],[\"name/17\",[9,33.878]],[\"comment/17\",[]],[\"name/18\",[14,30.513]],[\"comment/18\",[]],[\"name/19\",[15,30.513]],[\"comment/19\",[]],[\"name/20\",[16,30.513]],[\"comment/20\",[]],[\"name/21\",[17,38.986]],[\"comment/21\",[]],[\"name/22\",[1,22.892]],[\"comment/22\",[]],[\"name/23\",[18,38.986]],[\"comment/23\",[]],[\"name/24\",[19,33.878]],[\"comment/24\",[]],[\"name/25\",[20,33.878]],[\"comment/25\",[]],[\"name/26\",[2,30.513]],[\"comment/26\",[]],[\"name/27\",[21,30.513]],[\"comment/27\",[]],[\"name/28\",[22,33.878]],[\"comment/28\",[]],[\"name/29\",[23,33.878]],[\"comment/29\",[]],[\"name/30\",[14,30.513]],[\"comment/30\",[]],[\"name/31\",[15,30.513]],[\"comment/31\",[]],[\"name/32\",[16,30.513]],[\"comment/32\",[]],[\"name/33\",[24,33.878]],[\"comment/33\",[]],[\"name/34\",[25,33.878]],[\"comment/34\",[]],[\"name/35\",[26,38.986]],[\"comment/35\",[]],[\"name/36\",[1,22.892]],[\"comment/36\",[]],[\"name/37\",[27,33.878]],[\"comment/37\",[]],[\"name/38\",[28,38.986]],[\"comment/38\",[]],[\"name/39\",[29,38.986]],[\"comment/39\",[]],[\"name/40\",[30,38.986]],[\"comment/40\",[]],[\"name/41\",[31,38.986]],[\"comment/41\",[]],[\"name/42\",[32,38.986]],[\"comment/42\",[]],[\"name/43\",[33,38.986]],[\"comment/43\",[]],[\"name/44\",[19,33.878]],[\"comment/44\",[]],[\"name/45\",[20,33.878]],[\"comment/45\",[]],[\"name/46\",[2,30.513]],[\"comment/46\",[]],[\"name/47\",[21,30.513]],[\"comment/47\",[]],[\"name/48\",[22,33.878]],[\"comment/48\",[]],[\"name/49\",[23,33.878]],[\"comment/49\",[]],[\"name/50\",[14,30.513]],[\"comment/50\",[]],[\"name/51\",[15,30.513]],[\"comment/51\",[]],[\"name/52\",[16,30.513]],[\"comment/52\",[]],[\"name/53\",[24,33.878]],[\"comment/53\",[]],[\"name/54\",[25,33.878]],[\"comment/54\",[]],[\"name/55\",[34,38.986]],[\"comment/55\",[]],[\"name/56\",[1,22.892]],[\"comment/56\",[]],[\"name/57\",[27,33.878]],[\"comment/57\",[]],[\"name/58\",[35,38.986]],[\"comment/58\",[]],[\"name/59\",[21,30.513]],[\"comment/59\",[]],[\"name/60\",[36,38.986]],[\"comment/60\",[]],[\"name/61\",[37,38.986]],[\"comment/61\",[]],[\"name/62\",[38,38.986]],[\"comment/62\",[]],[\"name/63\",[39,38.986]],[\"comment/63\",[]],[\"name/64\",[40,38.986]],[\"comment/64\",[]],[\"name/65\",[41,38.986]],[\"comment/65\",[]],[\"name/66\",[42,38.986]],[\"comment/66\",[]],[\"name/67\",[43,38.986]],[\"comment/67\",[]],[\"name/68\",[44,38.986]],[\"comment/68\",[]],[\"name/69\",[45,38.986]],[\"comment/69\",[]],[\"name/70\",[46,38.986]],[\"comment/70\",[]],[\"name/71\",[1,22.892]],[\"comment/71\",[]],[\"name/72\",[47,38.986]],[\"comment/72\",[]]],\"invertedIndex\":[[\"accessloggingbucket\",{\"_index\":14,\"name\":{\"18\":{},\"30\":{},\"50\":{}},\"comment\":{}}],[\"addamibackuppolicy\",{\"_index\":31,\"name\":{\"41\":{}},\"comment\":{}}],[\"addamiebsbackuppolicy\",{\"_index\":30,\"name\":{\"40\":{}},\"comment\":{}}],[\"addamiec2ebsbackuppolicy\",{\"_index\":32,\"name\":{\"42\":{}},\"comment\":{}}],[\"addamis3backuppolicy\",{\"_index\":29,\"name\":{\"39\":{}},\"comment\":{}}],[\"addfilesystem\",{\"_index\":27,\"name\":{\"37\":{},\"57\":{}},\"comment\":{}}],[\"addprojectpolicies\",{\"_index\":35,\"name\":{\"58\":{}},\"comment\":{}}],[\"addvmexportpolicy\",{\"_index\":28,\"name\":{\"38\":{}},\"comment\":{}}],[\"artifactbucket\",{\"_index\":16,\"name\":{\"20\":{},\"32\":{},\"52\":{}},\"comment\":{}}],[\"bucket\",{\"_index\":6,\"name\":{\"7\":{}},\"comment\":{}}],[\"bucketname\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"buildimagedataprops\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"buildimagedatastack\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"buildimagepipelineprops\",{\"_index\":12,\"name\":{\"14\":{}},\"comment\":{}}],[\"buildimagepipelinestack\",{\"_index\":17,\"name\":{\"21\":{}},\"comment\":{}}],[\"buildimagerepostack\",{\"_index\":8,\"name\":{\"9\":{}},\"comment\":{}}],[\"buildpolicyadditions\",{\"_index\":23,\"name\":{\"29\":{},\"49\":{}},\"comment\":{}}],[\"codebuild\",{\"_index\":42,\"name\":{\"66\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{},\"6\":{},\"10\":{},\"22\":{},\"36\":{},\"56\":{},\"71\":{}},\"comment\":{}}],[\"createdeploymentbucket\",{\"_index\":7,\"name\":{\"8\":{}},\"comment\":{}}],[\"databucket\",{\"_index\":13,\"name\":{\"16\":{}},\"comment\":{}}],[\"embeddedlinuxcodebuildprojectprops\",{\"_index\":33,\"name\":{\"43\":{}},\"comment\":{}}],[\"embeddedlinuxcodebuildprojectstack\",{\"_index\":34,\"name\":{\"55\":{}},\"comment\":{}}],[\"embeddedlinuxpipelineprops\",{\"_index\":18,\"name\":{\"23\":{}},\"comment\":{}}],[\"embeddedlinuxpipelinestack\",{\"_index\":26,\"name\":{\"35\":{}},\"comment\":{}}],[\"imagekind\",{\"_index\":10,\"name\":{\"12\":{},\"15\":{}},\"comment\":{}}],[\"imagerepo\",{\"_index\":19,\"name\":{\"24\":{},\"44\":{}},\"comment\":{}}],[\"imagetag\",{\"_index\":20,\"name\":{\"25\":{},\"45\":{}},\"comment\":{}}],[\"kas\",{\"_index\":39,\"name\":{\"63\":{}},\"comment\":{}}],[\"kind\",{\"_index\":45,\"name\":{\"69\":{}},\"comment\":{}}],[\"layerreponame\",{\"_index\":22,\"name\":{\"28\":{},\"48\":{}},\"comment\":{}}],[\"metaawsdemo\",{\"_index\":37,\"name\":{\"61\":{}},\"comment\":{}}],[\"nxpimx\",{\"_index\":41,\"name\":{\"65\":{}},\"comment\":{}}],[\"outputbucket\",{\"_index\":24,\"name\":{\"33\":{},\"53\":{}},\"comment\":{}}],[\"pipelinenetworkstack\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"poky\",{\"_index\":36,\"name\":{\"60\":{}},\"comment\":{}}],[\"pokyami\",{\"_index\":38,\"name\":{\"62\":{}},\"comment\":{}}],[\"projectkind\",{\"_index\":21,\"name\":{\"27\":{},\"47\":{},\"59\":{}},\"comment\":{}}],[\"renesas\",{\"_index\":40,\"name\":{\"64\":{}},\"comment\":{}}],[\"repo\",{\"_index\":47,\"name\":{\"72\":{}},\"comment\":{}}],[\"reponame\",{\"_index\":44,\"name\":{\"68\":{}},\"comment\":{}}],[\"repository\",{\"_index\":9,\"name\":{\"11\":{},\"17\":{}},\"comment\":{}}],[\"serveraccesslogsprefix\",{\"_index\":15,\"name\":{\"19\":{},\"31\":{},\"51\":{}},\"comment\":{}}],[\"sourcerepo\",{\"_index\":46,\"name\":{\"70\":{}},\"comment\":{}}],[\"sourcerepoprops\",{\"_index\":43,\"name\":{\"67\":{}},\"comment\":{}}],[\"subdirectoryname\",{\"_index\":25,\"name\":{\"34\":{},\"54\":{}},\"comment\":{}}],[\"ubuntu22_04\",{\"_index\":11,\"name\":{\"13\":{}},\"comment\":{}}],[\"vpc\",{\"_index\":2,\"name\":{\"2\":{},\"26\":{},\"46\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html index faa7a17..a41848f 100644 --- a/classes/BuildImageDataStack.html +++ b/classes/BuildImageDataStack.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:22
    • @@ -44,7 +44,6 @@

    Properties

    region account environment -terminationProtection? nestedStackResource? templateFile artifactId @@ -55,7 +54,8 @@

    Properties

    Accessors

    -
    permissionsBoundaryArn +
    terminationProtection +permissionsBoundaryArn dependencies stackName partition @@ -116,7 +116,7 @@
    props: Returns BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:26

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:24

    • Readonly tags

    tags: TagManager
    @@ -212,15 +212,6 @@

    ReadonlyInherited from cdk.Stack.environment

    • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:234

    -
    -

    Optional Readonly terminationProtection

    -
    terminationProtection?: boolean
    -

    Whether termination protection is enabled for this stack.

    -
    -

    Optional Readonly nestedStackResource

    nestedStackResource?: CfnResource
    @@ -230,7 +221,7 @@

    Optional

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:245

    • Readonly templateFile

    templateFile: string
    @@ -241,7 +232,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:252

    • Readonly artifactId

    artifactId: string
    @@ -250,7 +241,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:256

    • Readonly synthesizer

    synthesizer: IStackSynthesizer
    @@ -259,7 +250,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:261

    • Readonly Internal _versionReportingEnabled

    _versionReportingEnabled: boolean
    @@ -269,7 +260,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:269

    • Readonly Internal _crossRegionReferences

    _crossRegionReferences: boolean
    @@ -278,7 +269,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:275

    • Readonly node

    node: Node
    @@ -290,6 +281,29 @@

    ReadonlyDefined in node_modules/constructs/lib/construct.d.ts:265

    Accessors

    +
    +

    terminationProtection

    +
      +
    • get terminationProtection(): boolean
      • +
    • +

      Whether termination protection is enabled for this stack.

      +
      +

      Returns boolean

      +
      • +
    • set terminationProtection(value): void
      • +
    • +
      +

      Parameters

      +
        +
      • +
        value: boolean
      +

      Returns void

    Private permissionsBoundaryArn

      @@ -313,7 +327,7 @@

      Returns any

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:335

    • dependencies

      @@ -325,7 +339,7 @@

      Returns Stack

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:395

    • stackName

      @@ -344,7 +358,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:408

    • partition

      @@ -356,7 +370,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:412

    • urlSuffix

      @@ -368,7 +382,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:416

    • stackId

      @@ -383,7 +397,7 @@

      Example

      // After resol
    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:424

    • notificationArns

      @@ -395,7 +409,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:428

    • nested

      @@ -407,7 +421,7 @@

      Returns boolean

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:432

    • availabilityZones

      @@ -428,7 +442,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:477

    • nestedStackParent

      @@ -440,7 +454,7 @@

      Returns undefined

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:481

    • Private maxResources

    +
  • Defined in lib/build-image-data.ts:38

    • Static isStack

      @@ -541,7 +555,7 @@

      Returns any

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:344

    • toJsonString

      @@ -560,7 +574,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:348

    • toYamlString

      @@ -577,7 +591,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:352

    • reportMissingContextKey

      @@ -599,7 +613,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:361

    • renameLogicalId

      @@ -620,7 +634,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:368

    • getLogicalId

      @@ -648,7 +662,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:384

    • addDependency

      @@ -669,7 +683,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:391

    • formatArn

      @@ -695,7 +709,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:450

    • splitArn

      @@ -724,7 +738,7 @@

      Returns ArnCompo

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:461

    • addTransform

      @@ -751,7 +765,7 @@

      Example

      declare
    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:496

    • addMetadata

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:503

    • _addAssemblyDependency

      @@ -795,7 +809,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:513

    • _obtainAssemblyDependencies

      @@ -814,7 +828,7 @@

      Returns Element<

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:522

    • _removeAssemblyDependency

      @@ -836,7 +850,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:532

    • _synthesizeTemplate

      @@ -855,7 +869,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:537

    • regionalFact

      @@ -886,7 +900,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:557

    • exportValue

    +
  • Defined in lib/build-image-pipeline.ts:47
    • @@ -45,7 +45,6 @@

    Properties

    region account environment -terminationProtection? nestedStackResource? templateFile artifactId @@ -56,7 +55,8 @@

    Properties

    Accessors

    -
    permissionsBoundaryArn +
    terminationProtection +permissionsBoundaryArn dependencies stackName partition @@ -116,7 +116,7 @@
    props: Returns BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:48

    • Properties

    @@ -204,15 +204,6 @@

    ReadonlyInherited from cdk.Stack.environment

    • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:234

    -
    -

    Optional Readonly terminationProtection

    -
    terminationProtection?: boolean
    -

    Whether termination protection is enabled for this stack.

    -
    -

    Optional Readonly nestedStackResource

    nestedStackResource?: CfnResource
    @@ -222,7 +213,7 @@

    Optional

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:245

    • Readonly templateFile

    templateFile: string
    @@ -233,7 +224,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:252

    • Readonly artifactId

    artifactId: string
    @@ -242,7 +233,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:256

    • Readonly synthesizer

    synthesizer: IStackSynthesizer
    @@ -251,7 +242,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:261

    • Readonly Internal _versionReportingEnabled

    _versionReportingEnabled: boolean
    @@ -261,7 +252,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:269

    • Readonly Internal _crossRegionReferences

    _crossRegionReferences: boolean
    @@ -270,7 +261,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:275

    • Readonly node

    node: Node
    @@ -282,6 +273,29 @@

    ReadonlyDefined in node_modules/constructs/lib/construct.d.ts:265

    Accessors

    +
    +

    terminationProtection

    +
      +
    • get terminationProtection(): boolean
      • +
    • +

      Whether termination protection is enabled for this stack.

      +
      +

      Returns boolean

      +
      • +
    • set terminationProtection(value): void
      • +
    • +
      +

      Parameters

      +
        +
      • +
        value: boolean
      +

      Returns void

    Private permissionsBoundaryArn

      @@ -305,7 +319,7 @@

      Returns any

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:335

    • dependencies

      @@ -317,7 +331,7 @@

      Returns Stack

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:395

    • stackName

      @@ -336,7 +350,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:408

    • partition

      @@ -348,7 +362,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:412

    • urlSuffix

      @@ -360,7 +374,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:416

    • stackId

      @@ -375,7 +389,7 @@

      Example

      // After resol
    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:424

    • notificationArns

      @@ -387,7 +401,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:428

    • nested

      @@ -399,7 +413,7 @@

      Returns boolean

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:432

    • availabilityZones

      @@ -420,7 +434,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:477

    • nestedStackParent

      @@ -432,7 +446,7 @@

      Returns undefined

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:481

    • Private maxResources

      @@ -514,7 +528,7 @@

      Returns any

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:344

    • toJsonString

      @@ -533,7 +547,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:348

    • toYamlString

      @@ -550,7 +564,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:352

    • reportMissingContextKey

      @@ -572,7 +586,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:361

    • renameLogicalId

      @@ -593,7 +607,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:368

    • getLogicalId

      @@ -621,7 +635,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:384

    • addDependency

      @@ -642,7 +656,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:391

    • formatArn

      @@ -668,7 +682,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:450

    • splitArn

      @@ -697,7 +711,7 @@

      Returns ArnCompo

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:461

    • addTransform

      @@ -724,7 +738,7 @@

      Example

      declare
    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:496

    • addMetadata

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:503

    • _addAssemblyDependency

      @@ -768,7 +782,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:513

    • _obtainAssemblyDependencies

      @@ -787,7 +801,7 @@

      Returns Element<

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:522

    • _removeAssemblyDependency

      @@ -809,7 +823,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:532

    • _synthesizeTemplate

      @@ -828,7 +842,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:537

    • regionalFact

      @@ -859,7 +873,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:557

    • exportValue

    +
  • Defined in lib/build-image-repo.ts:10
    • @@ -45,7 +45,6 @@

    Properties

    region account environment -terminationProtection? nestedStackResource? templateFile artifactId @@ -56,7 +55,8 @@

    Properties

    Accessors

    -
    permissionsBoundaryArn +
    terminationProtection +permissionsBoundaryArn dependencies stackName partition @@ -116,7 +116,7 @@
    Optional Returns BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:14

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-repo.ts:12

    • Readonly tags

    tags: TagManager
    @@ -212,15 +212,6 @@

    ReadonlyInherited from cdk.Stack.environment

    • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:234

    -
    -

    Optional Readonly terminationProtection

    -
    terminationProtection?: boolean
    -

    Whether termination protection is enabled for this stack.

    -
    -

    Optional Readonly nestedStackResource

    nestedStackResource?: CfnResource
    @@ -230,7 +221,7 @@

    Optional

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:245

    • Readonly templateFile

    templateFile: string
    @@ -241,7 +232,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:252

    • Readonly artifactId

    artifactId: string
    @@ -250,7 +241,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:256

    • Readonly synthesizer

    synthesizer: IStackSynthesizer
    @@ -259,7 +250,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:261

    • Readonly Internal _versionReportingEnabled

    _versionReportingEnabled: boolean
    @@ -269,7 +260,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:269

    • Readonly Internal _crossRegionReferences

    _crossRegionReferences: boolean
    @@ -278,7 +269,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:275

    • Readonly node

    node: Node
    @@ -290,6 +281,29 @@

    ReadonlyDefined in node_modules/constructs/lib/construct.d.ts:265

    Accessors

    +
    +

    terminationProtection

    +
      +
    • get terminationProtection(): boolean
      • +
    • +

      Whether termination protection is enabled for this stack.

      +
      +

      Returns boolean

      +
      • +
    • set terminationProtection(value): void
      • +
    • +
      +

      Parameters

      +
        +
      • +
        value: boolean
      +

      Returns void

    Private permissionsBoundaryArn

      @@ -313,7 +327,7 @@

      Returns any

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:335

    • dependencies

      @@ -325,7 +339,7 @@

      Returns Stack

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:395

    • stackName

      @@ -344,7 +358,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:408

    • partition

      @@ -356,7 +370,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:412

    • urlSuffix

      @@ -368,7 +382,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:416

    • stackId

      @@ -383,7 +397,7 @@

      Example

      // After resol
    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:424

    • notificationArns

      @@ -395,7 +409,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:428

    • nested

      @@ -407,7 +421,7 @@

      Returns boolean

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:432

    • availabilityZones

      @@ -428,7 +442,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:477

    • nestedStackParent

      @@ -440,7 +454,7 @@

      Returns undefined

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:481

    • Private maxResources

      @@ -522,7 +536,7 @@

      Returns any

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:344

    • toJsonString

      @@ -541,7 +555,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:348

    • toYamlString

      @@ -558,7 +572,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:352

    • reportMissingContextKey

      @@ -580,7 +594,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:361

    • renameLogicalId

      @@ -601,7 +615,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:368

    • getLogicalId

      @@ -629,7 +643,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:384

    • addDependency

      @@ -650,7 +664,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:391

    • formatArn

      @@ -676,7 +690,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:450

    • splitArn

      @@ -705,7 +719,7 @@

      Returns ArnCompo

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:461

    • addTransform

      @@ -732,7 +746,7 @@

      Example

      declare
    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:496

    • addMetadata

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:503

    • _addAssemblyDependency

      @@ -776,7 +790,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:513

    • _obtainAssemblyDependencies

      @@ -795,7 +809,7 @@

      Returns Element<

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:522

    • _removeAssemblyDependency

      @@ -817,7 +831,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:532

    • _synthesizeTemplate

      @@ -836,7 +850,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:537

    • regionalFact

      @@ -867,7 +881,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:557

    • exportValue

      @@ -886,14 +900,15 @@

      exportValue -

      Example

      Here is how the process works. Let's say there are two stacks, +

      Here is how the process works. Let's say there are two stacks, producerStack and consumerStack, and producerStack has a bucket called bucket, which is referenced by consumerStack (perhaps because an AWS Lambda Function writes into it, or something like that).

      It is not safe to remove producerStack.bucket because as the bucket is being deleted, consumerStack might still be using it.

      Instead, the process takes two deployments:

      -

      Deployment 1: break the relationship

        +

        Deployment 1: break the relationship:

        + -

        Deployment 2: remove the bucket resource

          +

          Deployment 2: remove the bucket resource:

          + diff --git a/classes/EmbeddedLinuxCodebuildProjectStack.html b/classes/EmbeddedLinuxCodebuildProjectStack.html new file mode 100644 index 0000000..aa5e575 --- /dev/null +++ b/classes/EmbeddedLinuxCodebuildProjectStack.html @@ -0,0 +1,1221 @@ +EmbeddedLinuxCodebuildProjectStack | aws4embeddedlinux-cdk-lib
          +
          + +
          +
          +
          +
          + +

          Class EmbeddedLinuxCodebuildProjectStack

          +
          +

          The stack for creating a build pipeline.

          +

          See EmbeddedLinuxCodebuildProjectProps for configration options.

          +
          +
          +
          +

          Hierarchy

          +
            +
          • Stack +
              +
            • EmbeddedLinuxCodebuildProjectStack
          +
          +
          +
          + +
          +
          +

          Constructors

          +
          constructor +
          +
          +

          Properties

          +
          tags +templateOptions +region +account +environment +nestedStackResource? +templateFile +artifactId +synthesizer +_versionReportingEnabled +_crossRegionReferences +node +
          +
          +

          Accessors

          +
          terminationProtection +permissionsBoundaryArn +dependencies +stackName +partition +urlSuffix +stackId +notificationArns +nested +availabilityZones +nestedStackParent +maxResources +bundlingRequired +
          +
          +

          Methods

          +
          addFileSystem +addProjectPolicies +isStack +of +resolve +toJsonString +toYamlString +reportMissingContextKey +renameLogicalId +getLogicalId +addDependency +formatArn +splitArn +addTransform +addMetadata +_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate +regionalFact +exportValue +exportStringListValue +allocateLogicalId +_validateId +_toCloudFormation +isConstruct +toString +
          +
          +

          Constructors

          +
          +

          constructor

          +
          +
          +

          Properties

          +
          +

          Readonly tags

          +
          tags: TagManager
          +

          Tags to be applied to the stack.

          +
          +
          +
          +

          Readonly templateOptions

          +
          templateOptions: ITemplateOptions
          +

          Options for CloudFormation template (like version, transform, description).

          +
          +
          +
          +

          Readonly region

          +
          region: string
          +

          The AWS region into which this stack will be deployed (e.g. us-west-2).

          +

          This value is resolved according to the following rules:

          +
            +
          1. The value provided to env.region when the stack is defined. This can +either be a concrete region (e.g. us-west-2) or the Aws.REGION +token.
            2. +
          2. Aws.REGION, which is represents the CloudFormation intrinsic reference +{ "Ref": "AWS::Region" } encoded as a string token.
            3. +
          +

          Preferably, you should use the return value as an opaque string and not +attempt to parse it to implement your logic. If you do, you must first +check that it is a concrete value an not an unresolved token. If this +value is an unresolved token (Token.isUnresolved(stack.region) returns +true), this implies that the user wishes that this stack will synthesize +into a region-agnostic template. In this case, your code should either +fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or +implement some other region-agnostic behavior.

          +
          +
          +
          +

          Readonly account

          +
          account: string
          +

          The AWS account into which this stack will be deployed.

          +

          This value is resolved according to the following rules:

          +
            +
          1. The value provided to env.account when the stack is defined. This can +either be a concrete account (e.g. 585695031111) or the +Aws.ACCOUNT_ID token.
            2. +
          2. Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference +{ "Ref": "AWS::AccountId" } encoded as a string token.
            3. +
          +

          Preferably, you should use the return value as an opaque string and not +attempt to parse it to implement your logic. If you do, you must first +check that it is a concrete value an not an unresolved token. If this +value is an unresolved token (Token.isUnresolved(stack.account) returns +true), this implies that the user wishes that this stack will synthesize +into a account-agnostic template. In this case, your code should either +fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or +implement some other region-agnostic behavior.

          +
          +
          +
          +

          Readonly environment

          +
          environment: string
          +

          The environment coordinates in which this stack is deployed. In the form +aws://account/region. Use stack.account and stack.region to obtain +the specific values, no need to parse.

          +

          You can use this value to determine if two stacks are targeting the same +environment.

          +

          If either stack.account or stack.region are not concrete values (e.g. +Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or +unknown-region will be used respectively to indicate this stack is +region/account-agnostic.

          +
          +
          +
          +

          Optional Readonly nestedStackResource

          +
          nestedStackResource?: CfnResource
          +

          If this is a nested stack, this represents its AWS::CloudFormation::Stack +resource. undefined for top-level (non-nested) stacks.

          +
          +
          +
          +

          Readonly templateFile

          +
          templateFile: string
          +

          The name of the CloudFormation template file emitted to the output +directory during synthesis.

          +

          Example value: MyStack.template.json

          +
          +
          +
          +

          Readonly artifactId

          +
          artifactId: string
          +

          The ID of the cloud assembly artifact for this stack.

          +
          +
          +
          +

          Readonly synthesizer

          +
          synthesizer: IStackSynthesizer
          +

          Synthesis method for this stack

          +
          +
          +
          +

          Readonly Internal _versionReportingEnabled

          +
          _versionReportingEnabled: boolean
          +

          Whether version reporting is enabled for this stack

          +

          Controls whether the CDK Metadata resource is injected

          +
          +
          +
          +

          Readonly Internal _crossRegionReferences

          +
          _crossRegionReferences: boolean
          +

          Whether cross region references are enabled for this stack

          +
          +
          +
          +

          Readonly node

          +
          node: Node
          +

          The tree node.

          +
          +
          +
          +

          Accessors

          +
          +

          terminationProtection

          +
            +
          • get terminationProtection(): boolean
            • +
          • +

            Whether termination protection is enabled for this stack.

            +
            +

            Returns boolean

            +
            • +
          • set terminationProtection(value): void
            • +
          • +
            +

            Parameters

            +
              +
            • +
              value: boolean
            +

            Returns void

          +
          +

          Private permissionsBoundaryArn

          +
            +
          • get permissionsBoundaryArn(): any
            • +
          • +

            If a permissions boundary has been applied on this scope or any parent scope +then this will return the ARN of the permissions boundary.

            +

            This will return the permissions boundary that has been applied to the most +specific scope.

            +

            For example:

            +

            const stage = new Stage(app, 'stage', { + permissionsBoundary: PermissionsBoundary.fromName('stage-pb'), +});

            +

            const stack = new Stack(stage, 'Stack', { + permissionsBoundary: PermissionsBoundary.fromName('some-other-pb'), +});

            +

            Stack.permissionsBoundaryArn === 'arn:${AWS::Partition}:iam::${AWS::AccountId}:policy/some-other-pb';

            +
            +

            Returns any

            the name of the permissions boundary or undefined if not set

            + +
          +
          +

          dependencies

          +
            +
          • get dependencies(): Stack[]
            • +
          • +

            Return the stacks this stack depends on

            +
            +

            Returns Stack[]

            +
          +
          +

          stackName

          +
            +
          • get stackName(): string
            • +
          • +

            The concrete CloudFormation physical stack name.

            +

            This is either the name defined explicitly in the stackName prop or +allocated based on the stack's location in the construct tree. Stacks that +are directly defined under the app use their construct id as their stack +name. Stacks that are defined deeper within the tree will use a hashed naming +scheme based on the construct path to ensure uniqueness.

            +

            If you wish to obtain the deploy-time AWS::StackName intrinsic, +you can use Aws.STACK_NAME directly.

            +
            +

            Returns string

            +
          +
          +

          partition

          +
            +
          • get partition(): string
            • +
          • +

            The partition in which this stack is defined

            +
            +

            Returns string

            +
          +
          +

          urlSuffix

          +
            +
          • get urlSuffix(): string
            • +
          • +

            The Amazon domain suffix for the region in which this stack is defined

            +
            +

            Returns string

            +
          +
          +

          stackId

          +
            +
          • get stackId(): string
            • +
          • +

            The ID of the stack

            +
            +

            Returns string

            +
            +

            Example

            // After resolving, looks like
            'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+
            +
          +
          +

          notificationArns

          +
            +
          • get notificationArns(): string[]
            • +
          • +

            Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

            +
            +

            Returns string[]

            +
          +
          +

          nested

          +
            +
          • get nested(): boolean
            • +
          • +

            Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

            +
            +

            Returns boolean

            +
          +
          +

          availabilityZones

          +
            +
          • get availabilityZones(): string[]
            • +
          • +

            Returns the list of AZs that are available in the AWS environment +(account/region) associated with this stack.

            +

            If the stack is environment-agnostic (either account and/or region are +tokens), this property will return an array with 2 tokens that will resolve +at deploy-time to the first two availability zones returned from CloudFormation's +Fn::GetAZs intrinsic function.

            +

            If they are not available in the context, returns a set of dummy values and +reports them as missing, and let the CLI resolve them by calling EC2 +DescribeAvailabilityZones on the target environment.

            +

            To specify a different strategy for selecting availability zones override this method.

            +
            +

            Returns string[]

            +
          +
          +

          nestedStackParent

          +
            +
          • get nestedStackParent(): undefined | Stack
            • +
          • +

            If this is a nested stack, returns it's parent stack.

            +
            +

            Returns undefined | Stack

            +
          +
          +

          Private maxResources

          +
            +
          • get maxResources(): any
            • +
          • +

            Maximum number of resources in the stack

            +

            Set to 0 to mean "unlimited".

            +
            +

            Returns any

            +
          +
          +

          bundlingRequired

          +
            +
          • get bundlingRequired(): boolean
            • +
          • +

            Indicates whether the stack requires bundling or not

            +
            +

            Returns boolean

            +
          +
          +

          Methods

          +
          +

          Private addFileSystem

          +
            + +
          • +

            Adds an EFS FileSystem to the VPC and SecurityGroup.

            +
            +
            +

            Parameters

            +
              +
            • +
              name: string
              +

              A name to differentiate the filesystem.

              +
              +
              • +
            • +
              vpc: IVpc
              +

              The VPC the Filesystem resides in.

              +
              +
              • +
            • +
              securityGroup: ISecurityGroup
              +

              A SecurityGroup to allow access to the filesystem from.

              +
              +
            +

            Returns string

            The filesystem location URL.

            + +
          +
          +

          Private addProjectPolicies

          +
          +
          +

          Static isStack

          +
            + +
          • +

            Return whether the given object is a Stack.

            +

            We do attribute detection since we can't reliably use 'instanceof'.

            +
            +
            +

            Parameters

            +
              +
            • +
              x: any
            +

            Returns x is Stack

            +
          +
          +

          Static of

          +
            + +
          • +

            Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

            +
            +
            +

            Parameters

            +
              +
            • +
              construct: IConstruct
              +

              The construct to start the search from.

              +
              +
            +

            Returns Stack

            +
          +
          +

          resolve

          +
            + +
          • +

            Resolve a tokenized value in the context of the current stack.

            +
            +
            +

            Parameters

            +
              +
            • +
              obj: any
            +

            Returns any

            +
          +
          +

          toJsonString

          +
            + +
          • +

            Convert an object, potentially containing tokens, to a JSON string

            +
            +
            +

            Parameters

            +
              +
            • +
              obj: any
              • +
            • +
              Optional space: number
            +

            Returns string

            +
          +
          +

          toYamlString

          +
            + +
          • +

            Convert an object, potentially containing tokens, to a YAML string

            +
            +
            +

            Parameters

            +
              +
            • +
              obj: any
            +

            Returns string

            +
          +
          +

          reportMissingContextKey

          +
            + +
          • +

            Indicate that a context key was expected

            +

            Contains instructions which will be emitted into the cloud assembly on how +the key should be supplied.

            +
            +
            +

            Parameters

            +
              +
            • +
              report: MissingContext
              +

              The set of parameters needed to obtain the context

              +
              +
            +

            Returns void

            +
          +
          +

          renameLogicalId

          +
            + +
          • +

            Rename a generated logical identities

            +

            To modify the naming scheme strategy, extend the Stack class and +override the allocateLogicalId method.

            +
            +
            +

            Parameters

            +
              +
            • +
              oldId: string
              • +
            • +
              newId: string
            +

            Returns void

            +
          +
          +

          getLogicalId

          +
            + +
          • +

            Allocates a stack-unique CloudFormation-compatible logical identity for a +specific resource.

            +

            This method is called when a CfnElement is created and used to render the +initial logical identity of resources. Logical ID renames are applied at +this stage.

            +

            This method uses the protected method allocateLogicalId to render the +logical ID for an element. To modify the naming scheme, extend the Stack +class and override this method.

            +
            +
            +

            Parameters

            +
              +
            • +
              element: CfnElement
              +

              The CloudFormation element for which a logical identity is +needed.

              +
              +
            +

            Returns string

            +
          +
          +

          addDependency

          +
            + +
          • +

            Add a dependency between this stack and another stack.

            +

            This can be used to define dependencies between any two stacks within an +app, and also supports nested stacks.

            +
            +
            +

            Parameters

            +
              +
            • +
              target: Stack
              • +
            • +
              Optional reason: string
            +

            Returns void

            +
          +
          +

          formatArn

          +
            + +
          • +

            Creates an ARN from components.

            +

            If partition, region or account are not specified, the stack's +partition, region and account will be used.

            +

            If any component is the empty string, an empty string will be inserted +into the generated ARN at the location that component corresponds to.

            +

            The ARN will be formatted as follows:

            +

            arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

            +

            The required ARN pieces that are omitted will be taken from the stack that +the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope +can be 'undefined'.

            +
            +
            +

            Parameters

            +
              +
            • +
              components: ArnComponents
            +

            Returns string

            +
          +
          +

          splitArn

          +
            + +
          • +

            Splits the provided ARN into its components. +Works both if 'arn' is a string like 'arn:aws:s3:::bucket', +and a Token representing a dynamic CloudFormation expression +(in which case the returned components will also be dynamic CloudFormation expressions, +encoded as Tokens).

            +
            +
            +

            Parameters

            +
              +
            • +
              arn: string
              +

              the ARN to split into its components

              +
              +
              • +
            • +
              arnFormat: ArnFormat
              +

              the expected format of 'arn' - depends on what format the service 'arn' represents uses

              +
              +
            +

            Returns ArnComponents

            +
          +
          +

          addTransform

          +
            + +
          • +

            Add a Transform to this stack. A Transform is a macro that AWS +CloudFormation uses to process your template.

            +

            Duplicate values are removed when stack is synthesized.

            +
            +
            +

            Parameters

            +
              +
            • +
              transform: string
              +

              The transform to add

              +
              +
            +

            Returns void

            +
            +

            See

            https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

            + +

            Example

            declare const stack: Stack;

            stack.addTransform('AWS::Serverless-2016-10-31')
+
            +
          +
          +

          addMetadata

          +
          +
          +

          _addAssemblyDependency

          +
            +
          • _addAssemblyDependency(target, reason?): void
            • +
          • Internal +

            Called implicitly by the addDependency helper function in order to +realize a dependency between two top-level stacks at the assembly level.

            +

            Use stack.addDependency to define the dependency between any two stacks, +and take into account nested stack relationships.

            +
            +
            +

            Parameters

            +
              +
            • +
              target: Stack
              • +
            • +
              Optional reason: StackDependencyReason
            +

            Returns void

            +
          +
          +

          _obtainAssemblyDependencies

          +
            +
          • _obtainAssemblyDependencies(reasonFilter): Element[]
            • +
          • Internal +

            Called implicitly by the obtainDependencies helper function in order to +collect resource dependencies across two top-level stacks at the assembly level.

            +

            Use stack.obtainDependencies to see the dependencies between any two stacks.

            +
            +
            +

            Parameters

            +
              +
            • +
              reasonFilter: StackDependencyReason
            +

            Returns Element[]

            +
          +
          +

          _removeAssemblyDependency

          +
            +
          • _removeAssemblyDependency(target, reasonFilter?): void
            • +
          • Internal +

            Called implicitly by the removeDependency helper function in order to +remove a dependency between two top-level stacks at the assembly level.

            +

            Use stack.addDependency to define the dependency between any two stacks, +and take into account nested stack relationships.

            +
            +
            +

            Parameters

            +
              +
            • +
              target: Stack
              • +
            • +
              Optional reasonFilter: StackDependencyReason
            +

            Returns void

            +
          +
          +

          _synthesizeTemplate

          +
            +
          • _synthesizeTemplate(session, lookupRoleArn?): void
            • +
          • Internal +

            Synthesizes the cloudformation template into a cloud assembly.

            +
            +
            +

            Parameters

            +
              +
            • +
              session: ISynthesisSession
              • +
            • +
              Optional lookupRoleArn: string
            +

            Returns void

            +
          +
          +

          regionalFact

          +
            + +
          • +

            Look up a fact value for the given fact for the region of this stack

            +

            Will return a definite value only if the region of the current stack is resolved. +If not, a lookup map will be added to the stack and the lookup will be done at +CDK deployment time.

            +

            What regions will be included in the lookup map is controlled by the +@aws-cdk/core:target-partitions context value: it must be set to a list +of partitions, and only regions from the given partitions will be included. +If no such context key is set, all regions will be included.

            +

            This function is intended to be used by construct library authors. Application +builders can rely on the abstractions offered by construct libraries and do +not have to worry about regional facts.

            +

            If defaultValue is not given, it is an error if the fact is unknown for +the given region.

            +
            +
            +

            Parameters

            +
              +
            • +
              factName: string
              • +
            • +
              Optional defaultValue: string
            +

            Returns string

            +
          +
          +

          exportValue

          +
            + +
          • +

            Create a CloudFormation Export for a string value

            +

            Returns a string representing the corresponding Fn.importValue() +expression for this Export. You can control the name for the export by +passing the name option.

            +

            If you don't supply a value for name, the value you're exporting must be +a Resource attribute (for example: bucket.bucketName) and it will be +given the same name as the automatic cross-stack reference that would be created +if you used the attribute in another Stack.

            +

            One of the uses for this method is to remove the relationship between +two Stacks established by automatic cross-stack references. It will +temporarily ensure that the CloudFormation Export still exists while you +remove the reference from the consuming stack. After that, you can remove +the resource and the manual export.

            +

            Here is how the process works. Let's say there are two stacks, +producerStack and consumerStack, and producerStack has a bucket +called bucket, which is referenced by consumerStack (perhaps because +an AWS Lambda Function writes into it, or something like that).

            +

            It is not safe to remove producerStack.bucket because as the bucket is being +deleted, consumerStack might still be using it.

            +

            Instead, the process takes two deployments:

            +

            Deployment 1: break the relationship:

            +
              +
            • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer +stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just +remove the Lambda Function altogether).
              • +
            • In the ProducerStack class, call this.exportValue(this.bucket.bucketName). This +will make sure the CloudFormation Export continues to exist while the relationship +between the two stacks is being broken.
              • +
            • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).
              • +
            +

            Deployment 2: remove the bucket resource:

            +
              +
            • You are now free to remove the bucket resource from producerStack.
              • +
            • Don't forget to remove the exportValue() call as well.
              • +
            • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
              • +
            +
            +
            +

            Parameters

            +
              +
            • +
              exportedValue: any
              • +
            • +
              Optional options: ExportValueOptions
            +

            Returns string

            +
          +
          +

          exportStringListValue

          +
            + +
          • +

            Create a CloudFormation Export for a string list value

            +

            Returns a string list representing the corresponding Fn.importValue() +expression for this Export. The export expression is automatically wrapped with an +Fn::Join and the import value with an Fn::Split, since CloudFormation can only +export strings. You can control the name for the export by passing the name option.

            +

            If you don't supply a value for name, the value you're exporting must be +a Resource attribute (for example: bucket.bucketName) and it will be +given the same name as the automatic cross-stack reference that would be created +if you used the attribute in another Stack.

            +

            One of the uses for this method is to remove the relationship between +two Stacks established by automatic cross-stack references. It will +temporarily ensure that the CloudFormation Export still exists while you +remove the reference from the consuming stack. After that, you can remove +the resource and the manual export.

            +

            See exportValue for an example of this process.

            +
            +
            +

            Parameters

            +
              +
            • +
              exportedValue: any
              • +
            • +
              Optional options: ExportValueOptions
            +

            Returns string[]

            +
          +
          +

          Protected allocateLogicalId

          +
            + +
          • +

            Returns the naming scheme used to allocate logical IDs. By default, uses +the HashedAddressingScheme but this method can be overridden to customize +this behavior.

            +

            In order to make sure logical IDs are unique and stable, we hash the resource +construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as +a suffix to the path components joined without a separator (CloudFormation +IDs only allow alphanumeric characters).

            +

            The result will be:

            +

            <path.join('')><md5(path.join('/')> + "human" "hash"

            +

            If the "human" part of the ID exceeds 240 characters, we simply trim it so +the total ID doesn't exceed CloudFormation's 255 character limit.

            +

            We only take 8 characters from the md5 hash (0.000005 chance of collision).

            +

            Special cases:

            +
              +
            • If the path only contains a single component (i.e. it's a top-level +resource), we won't add the hash to it. The hash is not needed for +disambiguation and also, it allows for a more straightforward migration an +existing CloudFormation template to a CDK stack without logical ID changes +(or renames).
              • +
            • For aesthetic reasons, if the last components of the path are the same +(i.e. L1/L2/Pipeline/Pipeline), they will be de-duplicated to make the +resulting human portion of the ID more pleasing: L1L2Pipeline<HASH> +instead of L1L2PipelinePipeline<HASH>
              • +
            • If a component is named "Default" it will be omitted from the path. This +allows refactoring higher level abstractions around constructs without affecting +the IDs of already deployed resources.
              • +
            • If a component is named "Resource" it will be omitted from the user-visible +path, but included in the hash. This reduces visual noise in the human readable +part of the identifier.
              • +
            +
            +
            +

            Parameters

            +
              +
            • +
              cfnElement: CfnElement
              +

              The element for which the logical ID is allocated.

              +
              +
            +

            Returns string

            +
          +
          +

          Protected _validateId

          +
            +
          • _validateId(name): void
            • +
          • Internal +

            Validate stack name

            +

            CloudFormation stack names can include dashes in addition to the regular identifier +character classes, and we don't allow one of the magic markers.

            +
            +
            +

            Parameters

            +
              +
            • +
              name: string
            +

            Returns void

            +
          +
          +

          Protected _toCloudFormation

          +
            +
          • _toCloudFormation(): any
            • +
          • Internal +

            Returns the CloudFormation template for this stack by traversing +the tree and invoking _toCloudFormation() on all Entity objects.

            +
            +

            Returns any

            +
          +
          +

          Static isConstruct

          +
            + +
          • +

            Checks if x is a construct.

            +

            Use this method instead of instanceof to properly detect Construct +instances, even when the construct library is symlinked.

            +

            Explanation: in JavaScript, multiple copies of the constructs library on +disk are seen as independent, completely different libraries. As a +consequence, the class Construct in each copy of the constructs library +is seen as a different class, and an instance of one class will not test as +instanceof the other class. npm install will not create installations +like this, but users may manually symlink construct libraries together or +use a monorepo tool: in those cases, multiple copies of the constructs +library can be accidentally installed, and instanceof will behave +unpredictably. It is safest to avoid using instanceof, and using +this type-testing method instead.

            +
            +
            +

            Parameters

            +
              +
            • +
              x: any
              +

              Any object

              +
              +
            +

            Returns x is Construct

            true if x is an object created from a class which extends Construct.

            + +
          +
          +

          toString

          +
            + +
          • +

            Returns a string representation of this construct.

            +
            +

            Returns string

            +
          +
          +
          +
          +
          +

          Settings

           +
          +
          +

          Member Visibility

          +
            +
            • +
            • +
            • +
          +
          +

          Theme

          +
          +

          On This Page

           +
          +
          +
          +
          +
          +

          Generated using TypeDoc

          +
          \ No newline at end of file diff --git a/classes/EmbeddedLinuxPipelineStack.html b/classes/EmbeddedLinuxPipelineStack.html index 3ac360f..99dac1f 100644 --- a/classes/EmbeddedLinuxPipelineStack.html +++ b/classes/EmbeddedLinuxPipelineStack.html @@ -27,7 +27,7 @@

          Hierarchy

          • EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:70
    • @@ -44,7 +44,6 @@

    Properties

    region account environment -terminationProtection? nestedStackResource? templateFile artifactId @@ -55,7 +54,8 @@

    Properties

    Accessors

    -
    permissionsBoundaryArn +
    terminationProtection +permissionsBoundaryArn dependencies stackName partition @@ -121,7 +121,7 @@
    props: Returns EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:71

    • Properties

    @@ -209,15 +209,6 @@

    ReadonlyInherited from cdk.Stack.environment

    • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:234

    -
    -

    Optional Readonly terminationProtection

    -
    terminationProtection?: boolean
    -

    Whether termination protection is enabled for this stack.

    -
    -

    Optional Readonly nestedStackResource

    nestedStackResource?: CfnResource
    @@ -227,7 +218,7 @@

    Optional

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:245

    • Readonly templateFile

    templateFile: string
    @@ -238,7 +229,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:252

    • Readonly artifactId

    artifactId: string
    @@ -247,7 +238,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:256

    • Readonly synthesizer

    synthesizer: IStackSynthesizer
    @@ -256,7 +247,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:261

    • Readonly Internal _versionReportingEnabled

    _versionReportingEnabled: boolean
    @@ -266,7 +257,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:269

    • Readonly Internal _crossRegionReferences

    _crossRegionReferences: boolean
    @@ -275,7 +266,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:275

    • Readonly node

    node: Node
    @@ -287,6 +278,29 @@

    ReadonlyDefined in node_modules/constructs/lib/construct.d.ts:265

    Accessors

    +
    +

    terminationProtection

    +
      +
    • get terminationProtection(): boolean
      • +
    • +

      Whether termination protection is enabled for this stack.

      +
      +

      Returns boolean

      +
      • +
    • set terminationProtection(value): void
      • +
    • +
      +

      Parameters

      +
        +
      • +
        value: boolean
      +

      Returns void

    Private permissionsBoundaryArn

      @@ -310,7 +324,7 @@

      Returns any

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:335

    • dependencies

      @@ -322,7 +336,7 @@

      Returns Stack

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:395

    • stackName

      @@ -341,7 +355,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:408

    • partition

      @@ -353,7 +367,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:412

    • urlSuffix

      @@ -365,7 +379,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:416

    • stackId

      @@ -380,7 +394,7 @@

      Example

      // After resol
    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:424

    • notificationArns

      @@ -392,7 +406,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:428

    • nested

      @@ -404,7 +418,7 @@

      Returns boolean

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:432

    • availabilityZones

      @@ -425,7 +439,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:477

    • nestedStackParent

      @@ -437,7 +451,7 @@

      Returns undefined

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:481

    • Private maxResources

    +
  • Defined in lib/embedded-linux-pipeline.ts:384

    • Private addVMExportPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:401

    • Private addAMIS3BackupPolicy

      @@ -515,7 +529,7 @@

      Parameters

      artifactBucketArn: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:416

    • Private addAMIEBSBackupPolicy

      @@ -528,7 +542,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:428

    • Private addAMIBackupPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:441

    • Private addAMIEC2EBSBackupPolicy

      @@ -549,7 +563,7 @@

      Parameters

      region: string

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:448

    • Static isStack

      @@ -604,7 +618,7 @@

      Returns any

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:344

    • toJsonString

      @@ -623,7 +637,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:348

    • toYamlString

      @@ -640,7 +654,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:352

    • reportMissingContextKey

      @@ -662,7 +676,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:361

    • renameLogicalId

      @@ -683,7 +697,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:368

    • getLogicalId

      @@ -711,7 +725,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:384

    • addDependency

      @@ -732,7 +746,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:391

    • formatArn

      @@ -758,7 +772,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:450

    • splitArn

      @@ -787,7 +801,7 @@

      Returns ArnCompo

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:461

    • addTransform

      @@ -814,7 +828,7 @@

      Example

      declare
    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:496

    • addMetadata

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:503

    • _addAssemblyDependency

      @@ -858,7 +872,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:513

    • _obtainAssemblyDependencies

      @@ -877,7 +891,7 @@

      Returns Element<

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:522

    • _removeAssemblyDependency

      @@ -899,7 +913,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:532

    • _synthesizeTemplate

      @@ -918,7 +932,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:537

    • regionalFact

      @@ -949,7 +963,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:557

    • exportValue

    +
  • Defined in lib/network.ts:12
    • @@ -46,7 +46,6 @@

    Properties

    region account environment -terminationProtection? nestedStackResource? templateFile artifactId @@ -57,7 +56,8 @@

    Properties

    Accessors

    -
    permissionsBoundaryArn +
    terminationProtection +permissionsBoundaryArn dependencies stackName partition @@ -115,7 +115,7 @@
    Optional Returns PipelineNetworkStack
    +
  • Defined in lib/network.ts:16

    • Properties

    @@ -125,7 +125,7 @@

    Readonly

    +
  • Defined in lib/network.ts:14

    • Readonly tags

    tags: TagManager
    @@ -211,15 +211,6 @@

    ReadonlyInherited from cdk.Stack.environment

    • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:234

    -
    -

    Optional Readonly terminationProtection

    -
    terminationProtection?: boolean
    -

    Whether termination protection is enabled for this stack.

    -
    -

    Optional Readonly nestedStackResource

    nestedStackResource?: CfnResource
    @@ -229,7 +220,7 @@

    Optional

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:245

    • Readonly templateFile

    templateFile: string
    @@ -240,7 +231,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:252

    • Readonly artifactId

    artifactId: string
    @@ -249,7 +240,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:256

    • Readonly synthesizer

    synthesizer: IStackSynthesizer
    @@ -258,7 +249,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:261

    • Readonly Internal _versionReportingEnabled

    _versionReportingEnabled: boolean
    @@ -268,7 +259,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:269

    • Readonly Internal _crossRegionReferences

    _crossRegionReferences: boolean
    @@ -277,7 +268,7 @@

    Readonly

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:275

    • Readonly node

    node: Node
    @@ -289,6 +280,29 @@

    ReadonlyDefined in node_modules/constructs/lib/construct.d.ts:265

    Accessors

    +
    +

    terminationProtection

    +
      +
    • get terminationProtection(): boolean
      • +
    • +

      Whether termination protection is enabled for this stack.

      +
      +

      Returns boolean

      +
      • +
    • set terminationProtection(value): void
      • +
    • +
      +

      Parameters

      +
        +
      • +
        value: boolean
      +

      Returns void

    Private permissionsBoundaryArn

      @@ -312,7 +326,7 @@

      Returns any

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:335

    • dependencies

      @@ -324,7 +338,7 @@

      Returns Stack

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:395

    • stackName

      @@ -343,7 +357,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:408

    • partition

      @@ -355,7 +369,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:412

    • urlSuffix

      @@ -367,7 +381,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:416

    • stackId

      @@ -382,7 +396,7 @@

      Example

      // After resol
    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:424

    • notificationArns

      @@ -394,7 +408,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:428

    • nested

      @@ -406,7 +420,7 @@

      Returns boolean

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:432

    • availabilityZones

      @@ -427,7 +441,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:477

    • nestedStackParent

      @@ -439,7 +453,7 @@

      Returns undefined

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:481

    • Private maxResources

      @@ -521,7 +535,7 @@

      Returns any

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:344

    • toJsonString

      @@ -540,7 +554,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:348

    • toYamlString

      @@ -557,7 +571,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:352

    • reportMissingContextKey

      @@ -579,7 +593,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:361

    • renameLogicalId

      @@ -600,7 +614,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:368

    • getLogicalId

      @@ -628,7 +642,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:384

    • addDependency

      @@ -649,7 +663,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:391

    • formatArn

      @@ -675,7 +689,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:450

    • splitArn

      @@ -704,7 +718,7 @@

      Returns ArnCompo

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:461

    • addTransform

      @@ -731,7 +745,7 @@

      Example

      declare
    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:496

    • addMetadata

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:503

    • _addAssemblyDependency

      @@ -775,7 +789,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:513

    • _obtainAssemblyDependencies

      @@ -794,7 +808,7 @@

      Returns Element<

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:522

    • _removeAssemblyDependency

      @@ -816,7 +830,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:532

    • _synthesizeTemplate

      @@ -835,7 +849,7 @@

      Returns void

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:537

    • regionalFact

      @@ -866,7 +880,7 @@

      Returns string

    +
  • Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:557

    • exportValue

    +
  • Defined in lib/constructs/source-repo.ts:40
    • @@ -67,7 +67,7 @@
    props: Returns SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:44

    • Properties

    @@ -77,7 +77,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:42

    • Readonly node

    node: Node
    @@ -170,6 +170,8 @@

    ProjectKind
  • SourceRepoProps
  • SourceRepo
    • +
  • EmbeddedLinuxCodebuildProjectProps
    • +
  • EmbeddedLinuxCodebuildProjectStack
  • EmbeddedLinuxPipelineProps
  • EmbeddedLinuxPipelineStack
  • PipelineNetworkStack
    • diff --git a/enums/ImageKind.html b/enums/ImageKind.html index fc922b5..631100a 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -20,7 +20,7 @@

    Enumeration ImageKind

    +
  • Defined in lib/build-image-pipeline.ts:17
    • @@ -39,7 +39,7 @@

    Ubuntu22_04

    +
  • Defined in lib/build-image-pipeline.ts:19
    • @@ -72,6 +72,8 @@

    ProjectKind
  • SourceRepoProps
  • SourceRepo
    • +
  • EmbeddedLinuxCodebuildProjectProps
    • +
  • EmbeddedLinuxCodebuildProjectStack
  • EmbeddedLinuxPipelineProps
  • EmbeddedLinuxPipelineStack
  • PipelineNetworkStack

    • diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html index 3460742..96344b2 100644 --- a/enums/ProjectKind.html +++ b/enums/ProjectKind.html @@ -20,7 +20,7 @@

    Enumeration ProjectKind

    +
  • Defined in lib/constructs/source-repo.ts:10
    • @@ -34,6 +34,7 @@

    Enumeration Members

    Kas Renesas NxpImx +CodeBuild

    Enumeration Members

    @@ -44,7 +45,7 @@

    Poky

    +
  • Defined in lib/constructs/source-repo.ts:12

    • MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"
    @@ -52,7 +53,7 @@

    MetaAwsDemo

    +
  • Defined in lib/constructs/source-repo.ts:14

    • PokyAmi

    PokyAmi: "poky-ami"
    @@ -60,7 +61,7 @@

    PokyAmi

    +
  • Defined in lib/constructs/source-repo.ts:16

    • Kas

    Kas: "kas"
    @@ -68,7 +69,7 @@

    Kas

    +
  • Defined in lib/constructs/source-repo.ts:18

    • Renesas

    Renesas: "renesas"
    @@ -76,7 +77,7 @@

    Renesas

    +
  • Defined in lib/constructs/source-repo.ts:20

    • NxpImx

    NxpImx: "nxp-imx"
    @@ -84,7 +85,15 @@

    NxpImx

    +
  • Defined in lib/constructs/source-repo.ts:22
    • +
    +

    CodeBuild

    +
    CodeBuild: "codebuild"
    +

    Build no pipeline, just CodeBuild project to connect with GitHub actions.

    +
    +
    @@ -109,7 +118,8 @@

    PokyAmi
  • Kas
  • Renesas
    • -
  • NxpImx

    • +
  • NxpImx
    • +
  • CodeBuild
    • diff --git a/index.html b/index.html index a0b5f12..22483e2 100644 --- a/index.html +++ b/index.html @@ -129,6 +129,8 @@

    ProjectKind
  • SourceRepoProps
  • SourceRepo
    • +
  • EmbeddedLinuxCodebuildProjectProps
    • +
  • EmbeddedLinuxCodebuildProjectStack
  • EmbeddedLinuxPipelineProps
  • EmbeddedLinuxPipelineStack
  • PipelineNetworkStack
    • diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html index b0f3395..ebc2586 100644 --- a/interfaces/BuildImageDataProps.html +++ b/interfaces/BuildImageDataProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImageDataProps
    +
  • Defined in lib/build-image-data.ts:14
    • @@ -55,7 +55,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:16

    • Optional Readonly description

    description?: string
    @@ -262,6 +262,8 @@

    ProjectKind
  • SourceRepoProps
  • SourceRepo
    • +
  • EmbeddedLinuxCodebuildProjectProps
    • +
  • EmbeddedLinuxCodebuildProjectStack
  • EmbeddedLinuxPipelineProps
  • EmbeddedLinuxPipelineStack
  • PipelineNetworkStack
    • diff --git a/interfaces/BuildImagePipelineProps.html b/interfaces/BuildImagePipelineProps.html index 4b706e3..c4f303a 100644 --- a/interfaces/BuildImagePipelineProps.html +++ b/interfaces/BuildImagePipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • BuildImagePipelineProps
    +
  • Defined in lib/build-image-pipeline.ts:25
    • @@ -60,7 +60,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:27

    • Readonly dataBucket

    dataBucket: IBucket
    @@ -68,7 +68,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:29

    • Readonly repository

    repository: IRepository
    @@ -76,7 +76,7 @@

    Readonly

    +
  • Defined in lib/build-image-pipeline.ts:31

    • Optional Readonly accessLoggingBucket

    accessLoggingBucket?: Bucket
    @@ -84,7 +84,7 @@

    Optional

    +
  • Defined in lib/build-image-pipeline.ts:33

    • Optional Readonly serverAccessLogsPrefix

    serverAccessLogsPrefix?: string
    @@ -92,7 +92,7 @@

    Optional

    +
  • Defined in lib/build-image-pipeline.ts:35

    • Optional Readonly artifactBucket

    artifactBucket?: Bucket
    @@ -100,7 +100,7 @@

    Optional

    +
  • Defined in lib/build-image-pipeline.ts:37

    • Optional Readonly description

    description?: string
    @@ -312,6 +312,8 @@

    ProjectKind
  • SourceRepoProps
  • SourceRepo
    • +
  • EmbeddedLinuxCodebuildProjectProps
    • +
  • EmbeddedLinuxCodebuildProjectStack
  • EmbeddedLinuxPipelineProps
  • EmbeddedLinuxPipelineStack
  • PipelineNetworkStack
    • diff --git a/interfaces/EmbeddedLinuxCodebuildProjectProps.html b/interfaces/EmbeddedLinuxCodebuildProjectProps.html new file mode 100644 index 0000000..232d0c6 --- /dev/null +++ b/interfaces/EmbeddedLinuxCodebuildProjectProps.html @@ -0,0 +1,372 @@ +EmbeddedLinuxCodebuildProjectProps | aws4embeddedlinux-cdk-lib
    +
    + +
    +
    +
    +
    + +

    Interface EmbeddedLinuxCodebuildProjectProps

    +
    +

    Properties to allow customizing the build.

    +
    +
    +
    +

    Hierarchy

    +
      +
    • StackProps +
        +
      • EmbeddedLinuxCodebuildProjectProps
    +
    +
    +
    + +
    +
    +

    Properties

    +
    imageRepo +imageTag? +vpc +projectKind? +layerRepoName? +buildPolicyAdditions? +accessLoggingBucket? +serverAccessLogsPrefix? +artifactBucket? +outputBucket? +subDirectoryName? +description? +env? +stackName? +tags? +synthesizer? +terminationProtection? +analyticsReporting? +crossRegionReferences? +permissionsBoundary? +suppressTemplateIndentation? +
    +
    +

    Properties

    +
    +

    Readonly imageRepo

    +
    imageRepo: IRepository
    +

    ECR Repository where the Build Host Image resides.

    +
    +
    +
    +

    Optional Readonly imageTag

    +
    imageTag?: string
    +

    Tag for the Build Host Image

    +
    +
    +
    +

    Readonly vpc

    +
    vpc: IVpc
    +

    VPC where the networking setup resides.

    +
    +
    +
    +

    Optional Readonly projectKind

    +
    projectKind?: ProjectKind
    +

    The type of project being built.

    +
    +
    +
    +

    Optional Readonly layerRepoName

    +
    layerRepoName?: string
    +

    A name for the layer-repo that is created. Default is 'layer-repo'

    +
    +
    +
    +

    Optional Readonly buildPolicyAdditions

    +
    buildPolicyAdditions?: PolicyStatement[]
    +

    Additional policy statements to add to the build project.

    +
    +
    +
    +

    Optional Readonly accessLoggingBucket

    +
    accessLoggingBucket?: Bucket
    +

    Access logging bucket to use

    +
    +
    +
    +

    Optional Readonly serverAccessLogsPrefix

    +
    serverAccessLogsPrefix?: string
    +

    Access logging prefix to use

    +
    +
    +
    +

    Optional Readonly artifactBucket

    +
    artifactBucket?: Bucket
    +

    Artifact bucket to use

    +
    +
    +
    +

    Optional Readonly outputBucket

    +
    outputBucket?: Bucket | VMImportBucket
    +

    Output bucket to use

    +
    +
    +
    +

    Optional Readonly subDirectoryName

    +
    subDirectoryName?: string
    +

    Prefix for S3 object within bucket

    +
    +
    +
    +

    Optional Readonly description

    +
    description?: string
    +

    A description of the stack.

    +
    +
    +

    Default

    - No description.
+
    +
    +
    +

    Optional Readonly env

    +
    env?: Environment
    +

    The AWS environment (account/region) where this stack will be deployed.

    +

    Set the region/account fields of env to either a concrete value to +select the indicated environment (recommended for production stacks), or to +the values of environment variables +CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment +depend on the AWS credentials/configuration that the CDK CLI is executed +under (recommended for development stacks).

    +

    If the Stack is instantiated inside a Stage, any undefined +region/account fields from env will default to the same field on the +encompassing Stage, if configured there.

    +

    If either region or account are not set nor inherited from Stage, the +Stack will be considered "environment-agnostic"". Environment-agnostic +stacks can be deployed to any environment but may not be able to take +advantage of all features of the CDK. For example, they will not be able to +use environmental context lookups such as ec2.Vpc.fromLookup and will not +automatically translate Service Principals to the right format based on the +environment's AWS partition, and other such enhancements.

    +
    +
    +

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
+
    + +

    Default

      +
    • The environment of the containing Stage if available, +otherwise create the stack will be environment-agnostic.
      • +
    +
    +
    +

    Optional Readonly stackName

    +
    stackName?: string
    +

    Name to deploy the stack with

    +
    +
    +

    Default

    - Derived from construct path.
+
    +
    +
    +

    Optional Readonly tags

    +
    tags?: {
        [key: string]: string;
    }
    +

    Stack tags that will be applied to all the taggable resources and the stack itself.

    +
    +
    +

    Type declaration

    +
      +
    • +
      [key: string]: string
    +
    +

    Default

    {}
+
    +
    +
    +

    Optional Readonly synthesizer

    +
    synthesizer?: IStackSynthesizer
    +

    Synthesis method to use while deploying this stack

    +

    The Stack Synthesizer controls aspects of synthesis and deployment, +like how assets are referenced and what IAM roles to use. For more +information, see the README of the main CDK package.

    +

    If not specified, the defaultStackSynthesizer from App will be used. +If that is not specified, DefaultStackSynthesizer is used if +@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major +version is v2. In CDK v1 LegacyStackSynthesizer is the default if no +other synthesizer is specified.

    +
    +
    +

    Default

      +
    • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
      • +
    +
    +
    +

    Optional Readonly terminationProtection

    +
    terminationProtection?: boolean
    +

    Whether to enable termination protection for this stack.

    +
    +
    +

    Default

    false
+
    +
    +
    +

    Optional Readonly analyticsReporting

    +
    analyticsReporting?: boolean
    +

    Include runtime versioning information in this Stack

    +
    +
    +

    Default

    analyticsReporting setting of containing App, or value of +'aws:cdk:version-reporting' context key

    +
    +
    +

    Optional Readonly crossRegionReferences

    +
    crossRegionReferences?: boolean
    +

    Enable this flag to allow native cross region stack references.

    +

    Enabling this will create a CloudFormation custom resource +in both the producing stack and consuming stack in order to perform the export/import

    +

    This feature is currently experimental

    +
    +
    +

    Default

    false
+
    +
    +
    +

    Optional Readonly permissionsBoundary

    +
    permissionsBoundary?: PermissionsBoundary
    +

    Options for applying a permissions boundary to all IAM Roles +and Users created within this Stage

    +
    +
    +

    Default

    - no permissions boundary is applied
+
    +
    +
    +

    Optional Readonly suppressTemplateIndentation

    +
    suppressTemplateIndentation?: boolean
    +

    Enable this flag to suppress indentation in generated +CloudFormation templates.

    +

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation +context key will be used. If that is not specified, then the +default value false will be used.

    +
    +
    +

    Default

      +
    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
      • +
    +
    +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    +
    +

    On This Page

     +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/interfaces/EmbeddedLinuxPipelineProps.html b/interfaces/EmbeddedLinuxPipelineProps.html index a4e0150..7d16b21 100644 --- a/interfaces/EmbeddedLinuxPipelineProps.html +++ b/interfaces/EmbeddedLinuxPipelineProps.html @@ -26,7 +26,7 @@

    Hierarchy

    • EmbeddedLinuxPipelineProps
    +
  • Defined in lib/embedded-linux-pipeline.ts:40
    • @@ -65,7 +65,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:42

    • Optional Readonly imageTag

    imageTag?: string
    @@ -73,7 +73,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:44

    • Readonly vpc

    vpc: IVpc
    @@ -81,7 +81,7 @@

    Readonly

    +
  • Defined in lib/embedded-linux-pipeline.ts:46

    • Optional Readonly projectKind

    projectKind?: ProjectKind
    @@ -89,7 +89,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:48

    • Optional Readonly layerRepoName

    layerRepoName?: string
    @@ -97,7 +97,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:50

    • Optional Readonly buildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]
    @@ -105,7 +105,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:52

    • Optional Readonly accessLoggingBucket

    accessLoggingBucket?: Bucket
    @@ -113,7 +113,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:54

    • Optional Readonly serverAccessLogsPrefix

    serverAccessLogsPrefix?: string
    @@ -121,7 +121,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:56

    • Optional Readonly artifactBucket

    artifactBucket?: Bucket
    @@ -129,7 +129,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:58

    • Optional Readonly outputBucket

    outputBucket?: Bucket | VMImportBucket
    @@ -137,7 +137,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:60

    • Optional Readonly subDirectoryName

    subDirectoryName?: string
    @@ -145,7 +145,7 @@

    Optional

    +
  • Defined in lib/embedded-linux-pipeline.ts:62

    • Optional Readonly description

    description?: string
    @@ -362,6 +362,8 @@

    ProjectKind
  • SourceRepoProps
  • SourceRepo
    • +
  • EmbeddedLinuxCodebuildProjectProps
    • +
  • EmbeddedLinuxCodebuildProjectStack
  • EmbeddedLinuxPipelineProps
  • EmbeddedLinuxPipelineStack
  • PipelineNetworkStack
    • diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html index 74b7dc3..8b9bc0c 100644 --- a/interfaces/SourceRepoProps.html +++ b/interfaces/SourceRepoProps.html @@ -22,7 +22,7 @@

    Hierarchy

    • SourceRepoProps
    +
  • Defined in lib/constructs/source-repo.ts:27
    • @@ -52,7 +52,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:29

    • Readonly kind

    kind: ProjectKind
    @@ -60,7 +60,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:31

    • Optional Readonly description

    description?: string
    @@ -268,6 +268,8 @@

    ProjectKind
  • SourceRepoProps
  • SourceRepo
    • +
  • EmbeddedLinuxCodebuildProjectProps
    • +
  • EmbeddedLinuxCodebuildProjectStack
  • EmbeddedLinuxPipelineProps
  • EmbeddedLinuxPipelineStack
  • PipelineNetworkStack
    • diff --git a/modules.html b/modules.html index d9274a3..bb8c1f8 100644 --- a/modules.html +++ b/modules.html @@ -26,6 +26,7 @@

    Classes

    BuildImagePipelineStack BuildImageRepoStack SourceRepo +EmbeddedLinuxCodebuildProjectStack EmbeddedLinuxPipelineStack PipelineNetworkStack
    @@ -34,6 +35,7 @@

    Interfaces

    BuildImageDataProps BuildImagePipelineProps SourceRepoProps +EmbeddedLinuxCodebuildProjectProps EmbeddedLinuxPipelineProps
    @@ -63,6 +65,8 @@

    Theme

    -
    -
    -
      -
    • Preparing search index...
      • -
    • The search index is not available
    aws4embeddedlinux-cdk-lib -
    -
    -
    -
    - -

    Class BuildImageDataStack

    -
    -

    Input (Source) data for our BuildImagePipelineStack.

    -
    -
    -
    -

    Hierarchy

    -
      -
    • Stack -
        -
      • BuildImageDataStack
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    constructor -
    -
    -

    Properties

    -
    bucket -tags -templateOptions -region -account -environment -nestedStackResource? -templateFile -artifactId -synthesizer -_versionReportingEnabled -_crossRegionReferences -_notificationArns? -node -
    -
    -

    Accessors

    -
    terminationProtection -permissionsBoundaryArn -dependencies -stackName -partition -urlSuffix -stackId -notificationArns -nested -availabilityZones -nestedStackParent -maxResources -bundlingRequired -
    -
    -

    Methods

    -
    createDeploymentBucket -isStack -of -resolve -toJsonString -toYamlString -reportMissingContextKey -renameLogicalId -getLogicalId -addDependency -formatArn -splitArn -addTransform -addMetadata -_addAssemblyDependency -_obtainAssemblyDependencies -_removeAssemblyDependency -_synthesizeTemplate -regionalFact -exportValue -exportStringListValue -allocateLogicalId -_validateId -_toCloudFormation -isConstruct -toString -
    -
    -

    Constructors

    -
    -

    constructor

    -
    -
    -

    Properties

    -
    -

    Readonly bucket

    -
    bucket: IBucket
    -

    The bucket which will be consumed by the BuildImagePipelineStack.

    -
    -
    -
    -

    Readonly tags

    -
    tags: TagManager
    -

    Tags to be applied to the stack.

    -
    -
    -
    -

    Readonly templateOptions

    -
    templateOptions: ITemplateOptions
    -

    Options for CloudFormation template (like version, transform, description).

    -
    -
    -
    -

    Readonly region

    -
    region: string
    -

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    +BuildImageDataStack | aws4embeddedlinux-cdk-lib

    Class BuildImageDataStack

    Input (Source) data for our BuildImagePipelineStack.

    +

    Hierarchy

    • Stack
      • BuildImageDataStack

    Constructors

    constructor +

    Properties

    bucket +tags +templateOptions +region +account +environment +nestedStackResource? +templateFile +artifactId +synthesizer +_versionReportingEnabled +_crossRegionReferences +_notificationArns? +node +

    Accessors

    terminationProtection +dependencies +stackName +partition +urlSuffix +stackId +notificationArns +nested +availabilityZones +nestedStackParent +bundlingRequired +

    Methods

    isStack +of +resolve +toJsonString +toYamlString +reportMissingContextKey +renameLogicalId +getLogicalId +addDependency +formatArn +splitArn +addTransform +addMetadata +_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate +regionalFact +exportValue +exportStringListValue +allocateLogicalId +_validateId +_toCloudFormation +isConstruct +toString +

    Constructors

    constructor

    Properties

    Readonlybucket

    bucket: IBucket

    The bucket which will be consumed by the BuildImagePipelineStack.

    +

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    +

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    1. The value provided to env.region when the stack is defined. This can @@ -166,15 +70,7 @@

      Readonlyregion-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

      -

    -
    -
    -

    Readonly account

    -
    account: string
    -

    The AWS account into which this stack will be deployed.

    +

    Readonlyaccount

    account: string

    The AWS account into which this stack will be deployed.

    This value is resolved according to the following rules:

    1. The value provided to env.account when the stack is defined. This can @@ -191,15 +87,7 @@

      Readonlyaccount-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

      -

    -
    -
    -

    Readonly environment

    -
    environment: string
    -

    The environment coordinates in which this stack is deployed. In the form +

    Readonlyenvironment

    environment: string

    The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

    You can use this value to determine if two stacks are targeting the same @@ -208,449 +96,63 @@

    ReadonlyAws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

    -

    -
    -
    -

    Optional Readonly nestedStackResource

    -
    nestedStackResource?: CfnResource
    -

    If this is a nested stack, this represents its AWS::CloudFormation::Stack +

    Optional ReadonlynestedStackResource

    nestedStackResource?: CfnResource

    If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

    -
    -
    -
    -

    Readonly templateFile

    -
    templateFile: string
    -

    The name of the CloudFormation template file emitted to the output +

    ReadonlytemplateFile

    templateFile: string

    The name of the CloudFormation template file emitted to the output directory during synthesis.

    Example value: MyStack.template.json

    -
    -
    -
    -

    Readonly artifactId

    -
    artifactId: string
    -

    The ID of the cloud assembly artifact for this stack.

    -
    -
    -
    -

    Readonly synthesizer

    -
    synthesizer: IStackSynthesizer
    -

    Synthesis method for this stack

    -
    -
    -
    -

    Readonly Internal _versionReportingEnabled

    -
    _versionReportingEnabled: boolean
    -

    Whether version reporting is enabled for this stack

    +

    ReadonlyartifactId

    artifactId: string

    The ID of the cloud assembly artifact for this stack.

    +

    Readonlysynthesizer

    synthesizer: IStackSynthesizer

    Synthesis method for this stack

    +

    Readonly Internal_versionReportingEnabled

    _versionReportingEnabled: boolean

    Whether version reporting is enabled for this stack

    Controls whether the CDK Metadata resource is injected

    -
    -
    -
    -

    Readonly Internal _crossRegionReferences

    -
    _crossRegionReferences: boolean
    -

    Whether cross region references are enabled for this stack

    -
    -
    -
    -

    Optional Readonly Internal _notificationArns

    -
    _notificationArns?: string[]
    -

    SNS Notification ARNs to receive stack events.

    -
    -
    -
    -

    Readonly node

    -
    node: Node
    -

    The tree node.

    -
    -
    -
    -

    Accessors

    -
    -

    terminationProtection

    -
      -
    • get terminationProtection(): boolean
      • -
    • -

      Whether termination protection is enabled for this stack.

      -
      -

      Returns boolean

      -
      • -
    • set terminationProtection(value): void
      • -
    • -
      -

      Parameters

      -
        -
      • -
        value: boolean
      -

      Returns void

    -
    -

    Private permissionsBoundaryArn

    -
      -
    • get permissionsBoundaryArn(): any
      • -
    • -

      If a permissions boundary has been applied on this scope or any parent scope -then this will return the ARN of the permissions boundary.

      -

      This will return the permissions boundary that has been applied to the most -specific scope.

      -

      For example:

      -

      const stage = new Stage(app, 'stage', { - permissionsBoundary: PermissionsBoundary.fromName('stage-pb'), -});

      -

      const stack = new Stack(stage, 'Stack', { - permissionsBoundary: PermissionsBoundary.fromName('some-other-pb'), -});

      -

      Stack.permissionsBoundaryArn === 'arn:${AWS::Partition}:iam::${AWS::AccountId}:policy/some-other-pb';

      -
      -

      Returns any

      the name of the permissions boundary or undefined if not set

      - -
    -
    -

    dependencies

    -
      -
    • get dependencies(): Stack[]
      • -
    • -

      Return the stacks this stack depends on

      -
      -

      Returns Stack[]

      -
    -
    -

    stackName

    -
      -
    • get stackName(): string
      • -
    • -

      The concrete CloudFormation physical stack name.

      +

    Readonly Internal_crossRegionReferences

    _crossRegionReferences: boolean

    Whether cross region references are enabled for this stack

    +

    Optional Readonly Internal_notificationArns

    _notificationArns?: string[]

    SNS Notification ARNs to receive stack events.

    +

    Readonlynode

    node: Node

    The tree node.

    +

    Accessors

    terminationProtection

    • get terminationProtection(): boolean

    • Whether termination protection is enabled for this stack.

      +

      Returns boolean

    • set terminationProtection(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    dependencies

    • get dependencies(): Stack[]

    • Return the stacks this stack depends on

      +

      Returns Stack[]

    stackName

    • get stackName(): string

    • The concrete CloudFormation physical stack name.

      This is either the name defined explicitly in the stackName prop or -allocated based on the stack's location in the construct tree. Stacks that +allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack name. Stacks that are defined deeper within the tree will use a hashed naming scheme based on the construct path to ensure uniqueness.

      If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.

      -
      -

      Returns string

      -
    -
    -

    partition

    -
      -
    • get partition(): string
      • -
    • -

      The partition in which this stack is defined

      -
      -

      Returns string

      -
    -
    -

    urlSuffix

    -
      -
    • get urlSuffix(): string
      • -
    • -

      The Amazon domain suffix for the region in which this stack is defined

      -
      -

      Returns string

      -
    -
    -

    stackId

    -
      -
    • get stackId(): string
      • -
    • -

      The ID of the stack

      -
      -

      Returns string

      -
      -

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
-
      -
    -
    -

    notificationArns

    -
      -
    • get notificationArns(): string[]
      • -
    • -

      Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      -
      -

      Returns string[]

      -
    -
    -

    nested

    -
      -
    • get nested(): boolean
      • -
    • -

      Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      -
      -

      Returns boolean

      -
    -
    -

    availabilityZones

    -
      -
    • get availabilityZones(): string[]
      • -
    • -

      Returns the list of AZs that are available in the AWS environment +

      Returns string

    partition

    • get partition(): string

    • The partition in which this stack is defined

      +

      Returns string

    urlSuffix

    • get urlSuffix(): string

    • The Amazon domain suffix for the region in which this stack is defined

      +

      Returns string

    stackId

    • get stackId(): string

    • The ID of the stack

      +

      Returns string

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+
      + +

    notificationArns

    • get notificationArns(): string[]

    • Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      +

      Returns string[]

    nested

    • get nested(): boolean

    • Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      +

      Returns boolean

    availabilityZones

    • get availabilityZones(): string[]

    • Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

      If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve -at deploy-time to the first two availability zones returned from CloudFormation's +at deploy-time to the first two availability zones returned from CloudFormation's Fn::GetAZs intrinsic function.

      If they are not available in the context, returns a set of dummy values and reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

      To specify a different strategy for selecting availability zones override this method.

      -
      -

      Returns string[]

      -
    -
    -

    nestedStackParent

    -
      -
    • get nestedStackParent(): undefined | Stack
      • -
    • -

      If this is a nested stack, returns it's parent stack.

      -
      -

      Returns undefined | Stack

      -
    -
    -

    Private maxResources

    -
      -
    • get maxResources(): any
      • -
    • -

      Maximum number of resources in the stack

      -

      Set to 0 to mean "unlimited".

      -
      -

      Returns any

      -
    -
    -

    bundlingRequired

    -
      -
    • get bundlingRequired(): boolean
      • -
    • -

      Indicates whether the stack requires bundling or not

      -
      -

      Returns boolean

      -
    -
    -

    Methods

    -
    -

    Private createDeploymentBucket

    -
      - -
    • -

      Create a bucket and S3 deployment to this bucket.

      -
      -
      -

      Parameters

      -
        -
      • -
        bucketName: string
        -

        The name of the bucket. Must be globally unique.

        -
        -
      -

      Returns IBucket

      -
    -
    -

    Static isStack

    -
      - -
    • -

      Return whether the given object is a Stack.

      -

      We do attribute detection since we can't reliably use 'instanceof'.

      -
      -
      -

      Parameters

      -
        -
      • -
        x: any
      -

      Returns x is Stack

      -
    -
    -

    Static of

    -
      - -
    • -

      Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      -
      -
      -

      Parameters

      -
        -
      • -
        construct: IConstruct
        -

        The construct to start the search from.

        -
        -
      -

      Returns Stack

      -
    -
    -

    resolve

    -
      - -
    • -

      Resolve a tokenized value in the context of the current stack.

      -
      -
      -

      Parameters

      -
        -
      • -
        obj: any
      -

      Returns any

      -
    -
    -

    toJsonString

    -
      - -
    • -

      Convert an object, potentially containing tokens, to a JSON string

      -
      -
      -

      Parameters

      -
        -
      • -
        obj: any
        • -
      • -
        Optional space: number
      -

      Returns string

      -
    -
    -

    toYamlString

    -
      - -
    • -

      Convert an object, potentially containing tokens, to a YAML string

      -
      -
      -

      Parameters

      -
        -
      • -
        obj: any
      -

      Returns string

      -
    -
    -

    reportMissingContextKey

    -
      - -
    • -

      Indicate that a context key was expected

      +

      Returns string[]

    nestedStackParent

    • get nestedStackParent(): undefined | Stack

    • If this is a nested stack, returns it's parent stack.

      +

      Returns undefined | Stack

    bundlingRequired

    • get bundlingRequired(): boolean

    • Indicates whether the stack requires bundling or not

      +

      Returns boolean

    Methods

    StaticisStack

    • isStack(x: any): x is Stack

    • Return whether the given object is a Stack.

      +

      We do attribute detection since we can't reliably use 'instanceof'.

      +

      Parameters

      • x: any

      Returns x is Stack

    Staticof

    • of(construct: IConstruct): Stack

    • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      +

      Parameters

      • construct: IConstruct

        The construct to start the search from.

        +

      Returns Stack

    resolve

    • resolve(obj: any): any

    • Resolve a tokenized value in the context of the current stack.

      +

      Parameters

      • obj: any

      Returns any

    toJsonString

    • toJsonString(obj: any, space?: number): string

    • Convert an object, potentially containing tokens, to a JSON string

      +

      Parameters

      • obj: any
      • Optionalspace: number

      Returns string

    toYamlString

    • toYamlString(obj: any): string

    • Convert an object, potentially containing tokens, to a YAML string

      +

      Parameters

      • obj: any

      Returns string

    reportMissingContextKey

    • reportMissingContextKey(report: MissingContext): void

    • Indicate that a context key was expected

      Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

      -
      -
      -

      Parameters

      -
        -
      • -
        report: MissingContext
        -

        The set of parameters needed to obtain the context

        -
        -
      -

      Returns void

      -
    -
    -

    renameLogicalId

    -
      - -
    • -

      Rename a generated logical identities

      +

      Parameters

      • report: MissingContext

        The set of parameters needed to obtain the context

        +

      Returns void

    renameLogicalId

    • renameLogicalId(oldId: string, newId: string): void

    • Rename a generated logical identities

      To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

      -
      -
      -

      Parameters

      -
        -
      • -
        oldId: string
        • -
      • -
        newId: string
      -

      Returns void

      -
    -
    -

    getLogicalId

    -
      - -
    • -

      Allocates a stack-unique CloudFormation-compatible logical identity for a +

      Parameters

      • oldId: string
      • newId: string

      Returns void

    getLogicalId

    -
    -

    addDependency

    -
      - -
    • -

      Add a dependency between this stack and another stack.

      +

    Returns string

    addDependency

    • addDependency(target: Stack, reason?: string): void

    • Add a dependency between this stack and another stack.

      This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

      -
      -
      -

      Parameters

      -
        -
      • -
        target: Stack
        • -
      • -
        Optional reason: string
      -

      Returns void

      -
    -
    -

    formatArn

    -
      - -
    • -

      Creates an ARN from components.

      -

      If partition, region or account are not specified, the stack's +

      Parameters

      • target: Stack
      • Optionalreason: string

      Returns void

    formatArn

    • formatArn(components: ArnComponents): string

    • Creates an ARN from components.

      +

      If partition, region or account are not specified, the stack's partition, region and account will be used.

      If any component is the empty string, an empty string will be inserted into the generated ARN at the location that component corresponds to.

      The ARN will be formatted as follows:

      -

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      +

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      The required ARN pieces that are omitted will be taken from the stack that -the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope -can be 'undefined'.

      -
      -
      -

      Parameters

      -
        -
      • -
        components: ArnComponents
      -

      Returns string

      -
    -
    -

    splitArn

    -
      - -
    • -

      Splits the provided ARN into its components. -Works both if 'arn' is a string like 'arn:aws:s3:::bucket', +the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope +can be 'undefined'.

      +

      Parameters

      • components: ArnComponents

      Returns string

    splitArn

    • splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

    • Splits the provided ARN into its components. +Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

      -
      -
      -

      Parameters

      -
        -
      • -
        arn: string
        -

        the ARN to split into its components

        -
        -
        • -
      • -
        arnFormat: ArnFormat
        -

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        -
        -
      -

      Returns ArnComponents

      -
    -
    -

    addTransform

    -
      - -
    • -

      Add a Transform to this stack. A Transform is a macro that AWS +

      Parameters

      • arn: string

        the ARN to split into its components

        +
      • arnFormat: ArnFormat

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        +

      Returns ArnComponents

    addTransform

    -
    -

    addMetadata

    -
      - -
    • -

      Adds an arbitrary key-value pair, with information you want to record about the stack. +

    addMetadata

    -
    -

    _addAssemblyDependency

    -

    _addAssemblyDependency

    • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
    • Internal

      Called implicitly by the addDependency helper function in order to realize a dependency between two top-level stacks at the assembly level.

      Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

      -
      -
      -

      Parameters

      -
        -
      • -
        target: Stack
        • -
      • -
        Optional reason: StackDependencyReason
      -

      Returns void

      -
    -
    -

    _obtainAssemblyDependencies

    -
      -
    • _obtainAssemblyDependencies(reasonFilter): Element[]
      • -
    • Internal -

      Called implicitly by the obtainDependencies helper function in order to +

      Parameters

      • target: Stack
      • Optionalreason: StackDependencyReason

      Returns void

    _obtainAssemblyDependencies

    • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
    • Internal

      Called implicitly by the obtainDependencies helper function in order to collect resource dependencies across two top-level stacks at the assembly level.

      Use stack.obtainDependencies to see the dependencies between any two stacks.

      -
      -
      -

      Parameters

      -
        -
      • -
        reasonFilter: StackDependencyReason
      -

      Returns Element[]

      -
    -
    -

    _removeAssemblyDependency

    -
      -
    • _removeAssemblyDependency(target, reasonFilter?): void
      • -
    • Internal -

      Called implicitly by the removeDependency helper function in order to +

      Parameters

      • reasonFilter: StackDependencyReason

      Returns Element[]

    _removeAssemblyDependency

    • _removeAssemblyDependency(
          target: Stack,
          reasonFilter?: StackDependencyReason,
      ): void
    • Internal

      Called implicitly by the removeDependency helper function in order to remove a dependency between two top-level stacks at the assembly level.

      Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

      -
      -
      -

      Parameters

      -
        -
      • -
        target: Stack
        • -
      • -
        Optional reasonFilter: StackDependencyReason
      -

      Returns void

      -
    -
    -

    _synthesizeTemplate

    -
      -
    • _synthesizeTemplate(session, lookupRoleArn?, lookupRoleExternalId?, lookupRoleAdditionalOptions?): void
      • -
    • Internal -

      Synthesizes the cloudformation template into a cloud assembly.

      -
      -
      -

      Parameters

      -
        -
      • -
        session: ISynthesisSession
        • -
      • -
        Optional lookupRoleArn: string
        • -
      • -
        Optional lookupRoleExternalId: string
        • -
      • -
        Optional lookupRoleAdditionalOptions: {
            [key: string]: any;
        }
        -
          -
        • -
          [key: string]: any
      -

      Returns void

      -
    -
    -

    regionalFact

    -
      - -
    • -

      Look up a fact value for the given fact for the region of this stack

      +

      Parameters

      • target: Stack
      • OptionalreasonFilter: StackDependencyReason

      Returns void

    _synthesizeTemplate

    • _synthesizeTemplate(
          session: ISynthesisSession,
          lookupRoleArn?: string,
          lookupRoleExternalId?: string,
          lookupRoleAdditionalOptions?: { [key: string]: any },
      ): void
    • Internal

      Synthesizes the cloudformation template into a cloud assembly.

      +

      Parameters

      • session: ISynthesisSession
      • OptionallookupRoleArn: string
      • OptionallookupRoleExternalId: string
      • OptionallookupRoleAdditionalOptions: { [key: string]: any }

      Returns void

    regionalFact

    -
    -

    exportValue

    -
      - -
    • -

      Create a CloudFormation Export for a string value

      +

      Parameters

      • factName: string
      • OptionaldefaultValue: string

      Returns string

    exportValue

    Deployment 2: remove the bucket resource:

    • You are now free to remove the bucket resource from producerStack.
      • -
    • Don't forget to remove the exportValue() call as well.
      • +
    • Don't forget to remove the exportValue() call as well.
    • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
    -
    -
    -

    Parameters

    -
      -
    • -
      exportedValue: any
      • -
    • -
      Optional options: ExportValueOptions
    -

    Returns string

    -
    -
    -

    exportStringListValue

    -
      - -
    • -

      Create a CloudFormation Export for a string list value

      +

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string

    exportStringListValue

    • exportStringListValue(
          exportedValue: any,
          options?: ExportValueOptions,
      ): string[]

    • Create a CloudFormation Export for a string list value

      Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only export strings. You can control the name for the export by passing the name option.

      -

      If you don't supply a value for name, the value you're exporting must be +

      If you don't supply a value for name, the value you're exporting must be a Resource attribute (for example: bucket.bucketName) and it will be given the same name as the automatic cross-stack reference that would be created if you used the attribute in another Stack.

      @@ -992,25 +269,7 @@

      exportStringListValue remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

      See exportValue for an example of this process.

      -

      -
      -

      Parameters

      -
        -
      • -
        exportedValue: any
        • -
      • -
        Optional options: ExportValueOptions
      -

      Returns string[]

      -
    -
    -

    Protected allocateLogicalId

    -
      - -
    • -

      Returns the naming scheme used to allocate logical IDs. By default, uses +

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string[]

    ProtectedallocateLogicalId

    • allocateLogicalId(cfnElement: CfnElement): string

    • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize this behavior.

      In order to make sure logical IDs are unique and stable, we hash the resource @@ -1018,15 +277,15 @@

      Protected

      The result will be:

      -

      <path.join('')><md5(path.join('/')> - "human" "hash"

      +

      <path.join('')><md5(path.join('/')> +"human" "hash"

      If the "human" part of the ID exceeds 240 characters, we simply trim it so -the total ID doesn't exceed CloudFormation's 255 character limit.

      +the total ID doesn't exceed CloudFormation's 255 character limit.

      We only take 8 characters from the md5 hash (0.000005 chance of collision).

      Special cases:

        -
      • If the path only contains a single component (i.e. it's a top-level -resource), we won't add the hash to it. The hash is not needed for +
      • If the path only contains a single component (i.e. it's a top-level +resource), we won't add the hash to it. The hash is not needed for disambiguation and also, it allows for a more straightforward migration an existing CloudFormation template to a CDK stack without logical ID changes (or renames).
        • @@ -1041,58 +300,13 @@

        Protected

      -

      -
      -

      Parameters

      -
        -
      • -
        cfnElement: CfnElement
        -

        The element for which the logical ID is allocated.

        -
        -
      -

      Returns string

      -
    -
    -

    Protected _validateId

    -
      -
    • _validateId(name): void
      • -
    • Internal -

      Validate stack name

      +

      Parameters

      • cfnElement: CfnElement

        The element for which the logical ID is allocated.

        +

      Returns string

    Protected_validateId

    • _validateId(name: string): void
    • Internal

      Validate stack name

      CloudFormation stack names can include dashes in addition to the regular identifier -character classes, and we don't allow one of the magic markers.

      -
      -
      -

      Parameters

      -
        -
      • -
        name: string
      -

      Returns void

      -
    -
    -

    Protected _toCloudFormation

    -
      -
    • _toCloudFormation(): any
      • -
    • Internal -

      Returns the CloudFormation template for this stack by traversing +character classes, and we don't allow one of the magic markers.

      +

      Parameters

      • name: string

      Returns void

    Protected_toCloudFormation

    • _toCloudFormation(): any
    • Internal

      Returns the CloudFormation template for this stack by traversing the tree and invoking _toCloudFormation() on all Entity objects.

      -
      -

      Returns any

      -
    -
    -

    Static isConstruct

    -
      - -
    • -

      Checks if x is a construct.

      +

      Returns any

    StaticisConstruct

    • isConstruct(x: any): x is Construct

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      Explanation: in JavaScript, multiple copies of the constructs library on @@ -1105,123 +319,7 @@

      Static instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

      -

      -
      -

      Parameters

      -
        -
      • -
        x: any
        -

        Any object

        -
        -
      -

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

      - -
    -
    -

    toString

    -
      - -
    • -

      Returns a string representation of this construct.

      -
      -

      Returns string

      -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -

    On This Page

     -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Parameters

    • x: any

      Any object

      +

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

    +

    toString

    • toString(): string

    • Returns a string representation of this construct.

      +

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/BuildImagePipelineStack.html b/classes/BuildImagePipelineStack.html index 0c227c3..8493d8e 100644 --- a/classes/BuildImagePipelineStack.html +++ b/classes/BuildImagePipelineStack.html @@ -1,147 +1,59 @@ -BuildImagePipelineStack | aws4embeddedlinux-cdk-lib
    -
    - -
    -
    -
    -
    - -

    Class BuildImagePipelineStack

    -
    -

    The pipeline for building the CodeBuild Image used in other pipelines. This +BuildImagePipelineStack | aws4embeddedlinux-cdk-lib

    Class BuildImagePipelineStack

    The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

    For configuration options see BuildImagePipelineProps.

    -
    -
    -
    -

    Hierarchy

    -
      -
    • Stack -
        -
      • BuildImagePipelineStack
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    constructor -
    -
    -

    Properties

    -
    tags -templateOptions -region -account -environment -nestedStackResource? -templateFile -artifactId -synthesizer -_versionReportingEnabled -_crossRegionReferences -_notificationArns? -node -
    -
    -

    Accessors

    -
    terminationProtection -permissionsBoundaryArn -dependencies -stackName -partition -urlSuffix -stackId -notificationArns -nested -availabilityZones -nestedStackParent -maxResources -bundlingRequired -
    -
    -

    Methods

    -
    isStack -of -resolve -toJsonString -toYamlString -reportMissingContextKey -renameLogicalId -getLogicalId -addDependency -formatArn -splitArn -addTransform -addMetadata -_addAssemblyDependency -_obtainAssemblyDependencies -_removeAssemblyDependency -_synthesizeTemplate -regionalFact -exportValue -exportStringListValue -allocateLogicalId -_validateId -_toCloudFormation -isConstruct -toString -
    -
    -

    Constructors

    -
    -

    constructor

    -
    -
    -

    Properties

    -
    -

    Readonly tags

    -
    tags: TagManager
    -

    Tags to be applied to the stack.

    -
    -
    -
    -

    Readonly templateOptions

    -
    templateOptions: ITemplateOptions
    -

    Options for CloudFormation template (like version, transform, description).

    -
    -
    -
    -

    Readonly region

    -
    region: string
    -

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    +

    Hierarchy

    • Stack
      • BuildImagePipelineStack

    Constructors

    constructor +

    Properties

    tags +templateOptions +region +account +environment +nestedStackResource? +templateFile +artifactId +synthesizer +_versionReportingEnabled +_crossRegionReferences +_notificationArns? +node +

    Accessors

    terminationProtection +dependencies +stackName +partition +urlSuffix +stackId +notificationArns +nested +availabilityZones +nestedStackParent +bundlingRequired +

    Methods

    isStack +of +resolve +toJsonString +toYamlString +reportMissingContextKey +renameLogicalId +getLogicalId +addDependency +formatArn +splitArn +addTransform +addMetadata +_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate +regionalFact +exportValue +exportStringListValue +allocateLogicalId +_validateId +_toCloudFormation +isConstruct +toString +

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    +

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    1. The value provided to env.region when the stack is defined. This can @@ -158,15 +70,7 @@

      Readonlyregion-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

      -

    -
    -
    -

    Readonly account

    -
    account: string
    -

    The AWS account into which this stack will be deployed.

    +

    Readonlyaccount

    account: string

    The AWS account into which this stack will be deployed.

    This value is resolved according to the following rules:

    1. The value provided to env.account when the stack is defined. This can @@ -183,15 +87,7 @@

      Readonlyaccount-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

      -

    -
    -
    -

    Readonly environment

    -
    environment: string
    -

    The environment coordinates in which this stack is deployed. In the form +

    Readonlyenvironment

    environment: string

    The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

    You can use this value to determine if two stacks are targeting the same @@ -200,430 +96,63 @@

    ReadonlyAws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

    -

    -
    -
    -

    Optional Readonly nestedStackResource

    -
    nestedStackResource?: CfnResource
    -

    If this is a nested stack, this represents its AWS::CloudFormation::Stack +

    Optional ReadonlynestedStackResource

    nestedStackResource?: CfnResource

    If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

    -
    -
    -
    -

    Readonly templateFile

    -
    templateFile: string
    -

    The name of the CloudFormation template file emitted to the output +

    ReadonlytemplateFile

    templateFile: string

    The name of the CloudFormation template file emitted to the output directory during synthesis.

    Example value: MyStack.template.json

    -
    -
    -
    -

    Readonly artifactId

    -
    artifactId: string
    -

    The ID of the cloud assembly artifact for this stack.

    -
    -
    -
    -

    Readonly synthesizer

    -
    synthesizer: IStackSynthesizer
    -

    Synthesis method for this stack

    -
    -
    -
    -

    Readonly Internal _versionReportingEnabled

    -
    _versionReportingEnabled: boolean
    -

    Whether version reporting is enabled for this stack

    +

    ReadonlyartifactId

    artifactId: string

    The ID of the cloud assembly artifact for this stack.

    +

    Readonlysynthesizer

    synthesizer: IStackSynthesizer

    Synthesis method for this stack

    +

    Readonly Internal_versionReportingEnabled

    _versionReportingEnabled: boolean

    Whether version reporting is enabled for this stack

    Controls whether the CDK Metadata resource is injected

    -
    -
    -
    -

    Readonly Internal _crossRegionReferences

    -
    _crossRegionReferences: boolean
    -

    Whether cross region references are enabled for this stack

    -
    -
    -
    -

    Optional Readonly Internal _notificationArns

    -
    _notificationArns?: string[]
    -

    SNS Notification ARNs to receive stack events.

    -
    -
    -
    -

    Readonly node

    -
    node: Node
    -

    The tree node.

    -
    -
    -
    -

    Accessors

    -
    -

    terminationProtection

    -
      -
    • get terminationProtection(): boolean
      • -
    • -

      Whether termination protection is enabled for this stack.

      -
      -

      Returns boolean

      -
      • -
    • set terminationProtection(value): void
      • -
    • -
      -

      Parameters

      -
        -
      • -
        value: boolean
      -

      Returns void

    -
    -

    Private permissionsBoundaryArn

    -
      -
    • get permissionsBoundaryArn(): any
      • -
    • -

      If a permissions boundary has been applied on this scope or any parent scope -then this will return the ARN of the permissions boundary.

      -

      This will return the permissions boundary that has been applied to the most -specific scope.

      -

      For example:

      -

      const stage = new Stage(app, 'stage', { - permissionsBoundary: PermissionsBoundary.fromName('stage-pb'), -});

      -

      const stack = new Stack(stage, 'Stack', { - permissionsBoundary: PermissionsBoundary.fromName('some-other-pb'), -});

      -

      Stack.permissionsBoundaryArn === 'arn:${AWS::Partition}:iam::${AWS::AccountId}:policy/some-other-pb';

      -
      -

      Returns any

      the name of the permissions boundary or undefined if not set

      - -
    -
    -

    dependencies

    -
      -
    • get dependencies(): Stack[]
      • -
    • -

      Return the stacks this stack depends on

      -
      -

      Returns Stack[]

      -
    -
    -

    stackName

    -
      -
    • get stackName(): string
      • -
    • -

      The concrete CloudFormation physical stack name.

      +

    Readonly Internal_crossRegionReferences

    _crossRegionReferences: boolean

    Whether cross region references are enabled for this stack

    +

    Optional Readonly Internal_notificationArns

    _notificationArns?: string[]

    SNS Notification ARNs to receive stack events.

    +

    Readonlynode

    node: Node

    The tree node.

    +

    Accessors

    terminationProtection

    • get terminationProtection(): boolean

    • Whether termination protection is enabled for this stack.

      +

      Returns boolean

    • set terminationProtection(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    dependencies

    • get dependencies(): Stack[]

    • Return the stacks this stack depends on

      +

      Returns Stack[]

    stackName

    • get stackName(): string

    • The concrete CloudFormation physical stack name.

      This is either the name defined explicitly in the stackName prop or -allocated based on the stack's location in the construct tree. Stacks that +allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack name. Stacks that are defined deeper within the tree will use a hashed naming scheme based on the construct path to ensure uniqueness.

      If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.

      -
      -

      Returns string

      -
    -
    -

    partition

    -
      -
    • get partition(): string
      • -
    • -

      The partition in which this stack is defined

      -
      -

      Returns string

      -
    -
    -

    urlSuffix

    -
      -
    • get urlSuffix(): string
      • -
    • -

      The Amazon domain suffix for the region in which this stack is defined

      -
      -

      Returns string

      -
    -
    -

    stackId

    -
      -
    • get stackId(): string
      • -
    • -

      The ID of the stack

      -
      -

      Returns string

      -
      -

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
-
      -
    -
    -

    notificationArns

    -
      -
    • get notificationArns(): string[]
      • -
    • -

      Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      -
      -

      Returns string[]

      -
    -
    -

    nested

    -
      -
    • get nested(): boolean
      • -
    • -

      Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      -
      -

      Returns boolean

      -
    -
    -

    availabilityZones

    -
      -
    • get availabilityZones(): string[]
      • -
    • -

      Returns the list of AZs that are available in the AWS environment +

      Returns string

    partition

    • get partition(): string

    • The partition in which this stack is defined

      +

      Returns string

    urlSuffix

    • get urlSuffix(): string

    • The Amazon domain suffix for the region in which this stack is defined

      +

      Returns string

    stackId

    • get stackId(): string

    • The ID of the stack

      +

      Returns string

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+
      + +

    notificationArns

    • get notificationArns(): string[]

    • Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      +

      Returns string[]

    nested

    • get nested(): boolean

    • Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      +

      Returns boolean

    availabilityZones

    • get availabilityZones(): string[]

    • Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

      If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve -at deploy-time to the first two availability zones returned from CloudFormation's +at deploy-time to the first two availability zones returned from CloudFormation's Fn::GetAZs intrinsic function.

      If they are not available in the context, returns a set of dummy values and reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

      To specify a different strategy for selecting availability zones override this method.

      -
      -

      Returns string[]

      -
    -
    -

    nestedStackParent

    -
      -
    • get nestedStackParent(): undefined | Stack
      • -
    • -

      If this is a nested stack, returns it's parent stack.

      -
      -

      Returns undefined | Stack

      -
    -
    -

    Private maxResources

    -
      -
    • get maxResources(): any
      • -
    • -

      Maximum number of resources in the stack

      -

      Set to 0 to mean "unlimited".

      -
      -

      Returns any

      -
    -
    -

    bundlingRequired

    -
      -
    • get bundlingRequired(): boolean
      • -
    • -

      Indicates whether the stack requires bundling or not

      -
      -

      Returns boolean

      -
    -
    -

    Methods

    -
    -

    Static isStack

    -
      - -
    • -

      Return whether the given object is a Stack.

      -

      We do attribute detection since we can't reliably use 'instanceof'.

      -
      -
      -

      Parameters

      -
        -
      • -
        x: any
      -

      Returns x is Stack

      -
    -
    -

    Static of

    -
      - -
    • -

      Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      -
      -
      -

      Parameters

      -
        -
      • -
        construct: IConstruct
        -

        The construct to start the search from.

        -
        -
      -

      Returns Stack

      -
    -
    -

    resolve

    -
      - -
    • -

      Resolve a tokenized value in the context of the current stack.

      -
      -
      -

      Parameters

      -
        -
      • -
        obj: any
      -

      Returns any

      -
    -
    -

    toJsonString

    -
      - -
    • -

      Convert an object, potentially containing tokens, to a JSON string

      -
      -
      -

      Parameters

      -
        -
      • -
        obj: any
        • -
      • -
        Optional space: number
      -

      Returns string

      -
    -
    -

    toYamlString

    -
      - -
    • -

      Convert an object, potentially containing tokens, to a YAML string

      -
      -
      -

      Parameters

      -
        -
      • -
        obj: any
      -

      Returns string

      -
    -
    -

    reportMissingContextKey

    -
      - -
    • -

      Indicate that a context key was expected

      +

      Returns string[]

    nestedStackParent

    • get nestedStackParent(): undefined | Stack

    • If this is a nested stack, returns it's parent stack.

      +

      Returns undefined | Stack

    bundlingRequired

    • get bundlingRequired(): boolean

    • Indicates whether the stack requires bundling or not

      +

      Returns boolean

    Methods

    StaticisStack

    • isStack(x: any): x is Stack

    • Return whether the given object is a Stack.

      +

      We do attribute detection since we can't reliably use 'instanceof'.

      +

      Parameters

      • x: any

      Returns x is Stack

    Staticof

    • of(construct: IConstruct): Stack

    • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      +

      Parameters

      • construct: IConstruct

        The construct to start the search from.

        +

      Returns Stack

    resolve

    • resolve(obj: any): any

    • Resolve a tokenized value in the context of the current stack.

      +

      Parameters

      • obj: any

      Returns any

    toJsonString

    • toJsonString(obj: any, space?: number): string

    • Convert an object, potentially containing tokens, to a JSON string

      +

      Parameters

      • obj: any
      • Optionalspace: number

      Returns string

    toYamlString

    • toYamlString(obj: any): string

    • Convert an object, potentially containing tokens, to a YAML string

      +

      Parameters

      • obj: any

      Returns string

    reportMissingContextKey

    • reportMissingContextKey(report: MissingContext): void

    • Indicate that a context key was expected

      Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

      -
      -
      -

      Parameters

      -
        -
      • -
        report: MissingContext
        -

        The set of parameters needed to obtain the context

        -
        -
      -

      Returns void

      -
    -
    -

    renameLogicalId

    -
      - -
    • -

      Rename a generated logical identities

      +

      Parameters

      • report: MissingContext

        The set of parameters needed to obtain the context

        +

      Returns void

    renameLogicalId

    • renameLogicalId(oldId: string, newId: string): void

    • Rename a generated logical identities

      To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

      -
      -
      -

      Parameters

      -
        -
      • -
        oldId: string
        • -
      • -
        newId: string
      -

      Returns void

      -
    -
    -

    getLogicalId

    -
      - -
    • -

      Allocates a stack-unique CloudFormation-compatible logical identity for a +

      Parameters

      • oldId: string
      • newId: string

      Returns void

    getLogicalId

    -
    -

    addDependency

    -
      - -
    • -

      Add a dependency between this stack and another stack.

      +

    Returns string

    addDependency

    • addDependency(target: Stack, reason?: string): void

    • Add a dependency between this stack and another stack.

      This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

      -
      -
      -

      Parameters

      -
        -
      • -
        target: Stack
        • -
      • -
        Optional reason: string
      -

      Returns void

      -
    -
    -

    formatArn

    -
      - -
    • -

      Creates an ARN from components.

      -

      If partition, region or account are not specified, the stack's +

      Parameters

      • target: Stack
      • Optionalreason: string

      Returns void

    formatArn

    • formatArn(components: ArnComponents): string

    • Creates an ARN from components.

      +

      If partition, region or account are not specified, the stack's partition, region and account will be used.

      If any component is the empty string, an empty string will be inserted into the generated ARN at the location that component corresponds to.

      The ARN will be formatted as follows:

      -

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      +

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      The required ARN pieces that are omitted will be taken from the stack that -the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope -can be 'undefined'.

      -
      -
      -

      Parameters

      -
        -
      • -
        components: ArnComponents
      -

      Returns string

      -
    -
    -

    splitArn

    -
      - -
    • -

      Splits the provided ARN into its components. -Works both if 'arn' is a string like 'arn:aws:s3:::bucket', +the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope +can be 'undefined'.

      +

      Parameters

      • components: ArnComponents

      Returns string

    splitArn

    • splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

    • Splits the provided ARN into its components. +Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

      -
      -
      -

      Parameters

      -
        -
      • -
        arn: string
        -

        the ARN to split into its components

        -
        -
        • -
      • -
        arnFormat: ArnFormat
        -

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        -
        -
      -

      Returns ArnComponents

      -
    -
    -

    addTransform

    -
      - -
    • -

      Add a Transform to this stack. A Transform is a macro that AWS +

      Parameters

      • arn: string

        the ARN to split into its components

        +
      • arnFormat: ArnFormat

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        +

      Returns ArnComponents

    addTransform

    -
    -

    addMetadata

    -
      - -
    • -

      Adds an arbitrary key-value pair, with information you want to record about the stack. +

    addMetadata

    -
    -

    _addAssemblyDependency

    -

    _addAssemblyDependency

    • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
    • Internal

      Called implicitly by the addDependency helper function in order to realize a dependency between two top-level stacks at the assembly level.

      Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

      -
      -
      -

      Parameters

      -
        -
      • -
        target: Stack
        • -
      • -
        Optional reason: StackDependencyReason
      -

      Returns void

      -
    -
    -

    _obtainAssemblyDependencies

    -
      -
    • _obtainAssemblyDependencies(reasonFilter): Element[]
      • -
    • Internal -

      Called implicitly by the obtainDependencies helper function in order to +

      Parameters

      • target: Stack
      • Optionalreason: StackDependencyReason

      Returns void

    _obtainAssemblyDependencies

    • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
    • Internal

      Called implicitly by the obtainDependencies helper function in order to collect resource dependencies across two top-level stacks at the assembly level.

      Use stack.obtainDependencies to see the dependencies between any two stacks.

      -
      -
      -

      Parameters

      -
        -
      • -
        reasonFilter: StackDependencyReason
      -

      Returns Element[]

      -
    -
    -

    _removeAssemblyDependency

    -
      -
    • _removeAssemblyDependency(target, reasonFilter?): void
      • -
    • Internal -

      Called implicitly by the removeDependency helper function in order to +

      Parameters

      • reasonFilter: StackDependencyReason

      Returns Element[]

    _removeAssemblyDependency

    • _removeAssemblyDependency(
          target: Stack,
          reasonFilter?: StackDependencyReason,
      ): void
    • Internal

      Called implicitly by the removeDependency helper function in order to remove a dependency between two top-level stacks at the assembly level.

      Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

      -
      -
      -

      Parameters

      -
        -
      • -
        target: Stack
        • -
      • -
        Optional reasonFilter: StackDependencyReason
      -

      Returns void

      -
    -
    -

    _synthesizeTemplate

    -
      -
    • _synthesizeTemplate(session, lookupRoleArn?, lookupRoleExternalId?, lookupRoleAdditionalOptions?): void
      • -
    • Internal -

      Synthesizes the cloudformation template into a cloud assembly.

      -
      -
      -

      Parameters

      -
        -
      • -
        session: ISynthesisSession
        • -
      • -
        Optional lookupRoleArn: string
        • -
      • -
        Optional lookupRoleExternalId: string
        • -
      • -
        Optional lookupRoleAdditionalOptions: {
            [key: string]: any;
        }
        -
          -
        • -
          [key: string]: any
      -

      Returns void

      -
    -
    -

    regionalFact

    -
      - -
    • -

      Look up a fact value for the given fact for the region of this stack

      +

      Parameters

      • target: Stack
      • OptionalreasonFilter: StackDependencyReason

      Returns void

    _synthesizeTemplate

    • _synthesizeTemplate(
          session: ISynthesisSession,
          lookupRoleArn?: string,
          lookupRoleExternalId?: string,
          lookupRoleAdditionalOptions?: { [key: string]: any },
      ): void
    • Internal

      Synthesizes the cloudformation template into a cloud assembly.

      +

      Parameters

      • session: ISynthesisSession
      • OptionallookupRoleArn: string
      • OptionallookupRoleExternalId: string
      • OptionallookupRoleAdditionalOptions: { [key: string]: any }

      Returns void

    regionalFact

    -
    -

    exportValue

    -
      - -
    • -

      Create a CloudFormation Export for a string value

      +

      Parameters

      • factName: string
      • OptionaldefaultValue: string

      Returns string

    exportValue

    Deployment 2: remove the bucket resource:

    • You are now free to remove the bucket resource from producerStack.
      • -
    • Don't forget to remove the exportValue() call as well.
      • +
    • Don't forget to remove the exportValue() call as well.
    • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
    -
    -
    -

    Parameters

    -
      -
    • -
      exportedValue: any
      • -
    • -
      Optional options: ExportValueOptions
    -

    Returns string

    -
    -
    -

    exportStringListValue

    -
      - -
    • -

      Create a CloudFormation Export for a string list value

      +

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string

    exportStringListValue

    • exportStringListValue(
          exportedValue: any,
          options?: ExportValueOptions,
      ): string[]

    • Create a CloudFormation Export for a string list value

      Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only export strings. You can control the name for the export by passing the name option.

      -

      If you don't supply a value for name, the value you're exporting must be +

      If you don't supply a value for name, the value you're exporting must be a Resource attribute (for example: bucket.bucketName) and it will be given the same name as the automatic cross-stack reference that would be created if you used the attribute in another Stack.

      @@ -965,25 +269,7 @@

      exportStringListValue remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

      See exportValue for an example of this process.

      -

      -
      -

      Parameters

      -
        -
      • -
        exportedValue: any
        • -
      • -
        Optional options: ExportValueOptions
      -

      Returns string[]

      -
    -
    -

    Protected allocateLogicalId

    -
      - -
    • -

      Returns the naming scheme used to allocate logical IDs. By default, uses +

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string[]

    ProtectedallocateLogicalId

    • allocateLogicalId(cfnElement: CfnElement): string

    • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize this behavior.

      In order to make sure logical IDs are unique and stable, we hash the resource @@ -991,15 +277,15 @@

      Protected

      The result will be:

      -

      <path.join('')><md5(path.join('/')> - "human" "hash"

      +

      <path.join('')><md5(path.join('/')> +"human" "hash"

      If the "human" part of the ID exceeds 240 characters, we simply trim it so -the total ID doesn't exceed CloudFormation's 255 character limit.

      +the total ID doesn't exceed CloudFormation's 255 character limit.

      We only take 8 characters from the md5 hash (0.000005 chance of collision).

      Special cases:

        -
      • If the path only contains a single component (i.e. it's a top-level -resource), we won't add the hash to it. The hash is not needed for +
      • If the path only contains a single component (i.e. it's a top-level +resource), we won't add the hash to it. The hash is not needed for disambiguation and also, it allows for a more straightforward migration an existing CloudFormation template to a CDK stack without logical ID changes (or renames).
        • @@ -1014,58 +300,13 @@

        Protected

      -

      -
      -

      Parameters

      -
        -
      • -
        cfnElement: CfnElement
        -

        The element for which the logical ID is allocated.

        -
        -
      -

      Returns string

      -
    -
    -

    Protected _validateId

    -
      -
    • _validateId(name): void
      • -
    • Internal -

      Validate stack name

      +

      Parameters

      • cfnElement: CfnElement

        The element for which the logical ID is allocated.

        +

      Returns string

    Protected_validateId

    • _validateId(name: string): void
    • Internal

      Validate stack name

      CloudFormation stack names can include dashes in addition to the regular identifier -character classes, and we don't allow one of the magic markers.

      -
      -
      -

      Parameters

      -
        -
      • -
        name: string
      -

      Returns void

      -
    -
    -

    Protected _toCloudFormation

    -
      -
    • _toCloudFormation(): any
      • -
    • Internal -

      Returns the CloudFormation template for this stack by traversing +character classes, and we don't allow one of the magic markers.

      +

      Parameters

      • name: string

      Returns void

    Protected_toCloudFormation

    • _toCloudFormation(): any
    • Internal

      Returns the CloudFormation template for this stack by traversing the tree and invoking _toCloudFormation() on all Entity objects.

      -
      -

      Returns any

      -
    -
    -

    Static isConstruct

    -
      - -
    • -

      Checks if x is a construct.

      +

      Returns any

    StaticisConstruct

    • isConstruct(x: any): x is Construct

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      Explanation: in JavaScript, multiple copies of the constructs library on @@ -1078,121 +319,7 @@

      Static instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

      -

      -
      -

      Parameters

      -
        -
      • -
        x: any
        -

        Any object

        -
        -
      -

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

      - -
    -
    -

    toString

    -
      - -
    • -

      Returns a string representation of this construct.

      -
      -

      Returns string

      -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -

    On This Page

     -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Parameters

    • x: any

      Any object

      +

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

    +

    toString

    • toString(): string

    • Returns a string representation of this construct.

      +

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html index 68938a1..0b73dba 100644 --- a/classes/BuildImageRepoStack.html +++ b/classes/BuildImageRepoStack.html @@ -1,155 +1,60 @@ -BuildImageRepoStack | aws4embeddedlinux-cdk-lib
    -
    - -
    -
    -
    -
    - -

    Class BuildImageRepoStack

    -
    -

    The ECR Repository to store build host images.

    +BuildImageRepoStack | aws4embeddedlinux-cdk-lib

    Class BuildImageRepoStack

    The ECR Repository to store build host images.

    This is the output of the BuildImagePipelineStack

    -
    -
    -
    -

    Hierarchy

    -
      -
    • Stack -
        -
      • BuildImageRepoStack
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    constructor -
    -
    -

    Properties

    -
    repository -tags -templateOptions -region -account -environment -nestedStackResource? -templateFile -artifactId -synthesizer -_versionReportingEnabled -_crossRegionReferences -_notificationArns? -node -
    -
    -

    Accessors

    -
    terminationProtection -permissionsBoundaryArn -dependencies -stackName -partition -urlSuffix -stackId -notificationArns -nested -availabilityZones -nestedStackParent -maxResources -bundlingRequired -
    -
    -

    Methods

    -
    isStack -of -resolve -toJsonString -toYamlString -reportMissingContextKey -renameLogicalId -getLogicalId -addDependency -formatArn -splitArn -addTransform -addMetadata -_addAssemblyDependency -_obtainAssemblyDependencies -_removeAssemblyDependency -_synthesizeTemplate -regionalFact -exportValue -exportStringListValue -allocateLogicalId -_validateId -_toCloudFormation -isConstruct -toString -
    -
    -

    Constructors

    -
    -

    constructor

    -
    -
    -

    Properties

    -
    -

    Readonly repository

    -
    repository: IRepository
    -

    The respository to put the build host container in.

    -
    -
    -
    -

    Readonly tags

    -
    tags: TagManager
    -

    Tags to be applied to the stack.

    -
    -
    -
    -

    Readonly templateOptions

    -
    templateOptions: ITemplateOptions
    -

    Options for CloudFormation template (like version, transform, description).

    -
    -
    -
    -

    Readonly region

    -
    region: string
    -

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    +

    Hierarchy

    • Stack
      • BuildImageRepoStack

    Constructors

    constructor +

    Properties

    repository +tags +templateOptions +region +account +environment +nestedStackResource? +templateFile +artifactId +synthesizer +_versionReportingEnabled +_crossRegionReferences +_notificationArns? +node +

    Accessors

    terminationProtection +dependencies +stackName +partition +urlSuffix +stackId +notificationArns +nested +availabilityZones +nestedStackParent +bundlingRequired +

    Methods

    isStack +of +resolve +toJsonString +toYamlString +reportMissingContextKey +renameLogicalId +getLogicalId +addDependency +formatArn +splitArn +addTransform +addMetadata +_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate +regionalFact +exportValue +exportStringListValue +allocateLogicalId +_validateId +_toCloudFormation +isConstruct +toString +

    Constructors

    constructor

    Properties

    Readonlyrepository

    repository: IRepository

    The respository to put the build host container in.

    +

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    +

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    1. The value provided to env.region when the stack is defined. This can @@ -166,15 +71,7 @@

      Readonlyregion-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

      -

    -
    -
    -

    Readonly account

    -
    account: string
    -

    The AWS account into which this stack will be deployed.

    +

    Readonlyaccount

    account: string

    The AWS account into which this stack will be deployed.

    This value is resolved according to the following rules:

    1. The value provided to env.account when the stack is defined. This can @@ -191,15 +88,7 @@

      Readonlyaccount-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

      -

    -
    -
    -

    Readonly environment

    -
    environment: string
    -

    The environment coordinates in which this stack is deployed. In the form +

    Readonlyenvironment

    environment: string

    The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

    You can use this value to determine if two stacks are targeting the same @@ -208,430 +97,63 @@

    ReadonlyAws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

    -

    -
    -
    -

    Optional Readonly nestedStackResource

    -
    nestedStackResource?: CfnResource
    -

    If this is a nested stack, this represents its AWS::CloudFormation::Stack +

    Optional ReadonlynestedStackResource

    nestedStackResource?: CfnResource

    If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

    -
    -
    -
    -

    Readonly templateFile

    -
    templateFile: string
    -

    The name of the CloudFormation template file emitted to the output +

    ReadonlytemplateFile

    templateFile: string

    The name of the CloudFormation template file emitted to the output directory during synthesis.

    Example value: MyStack.template.json

    -
    -
    -
    -

    Readonly artifactId

    -
    artifactId: string
    -

    The ID of the cloud assembly artifact for this stack.

    -
    -
    -
    -

    Readonly synthesizer

    -
    synthesizer: IStackSynthesizer
    -

    Synthesis method for this stack

    -
    -
    -
    -

    Readonly Internal _versionReportingEnabled

    -
    _versionReportingEnabled: boolean
    -

    Whether version reporting is enabled for this stack

    +

    ReadonlyartifactId

    artifactId: string

    The ID of the cloud assembly artifact for this stack.

    +

    Readonlysynthesizer

    synthesizer: IStackSynthesizer

    Synthesis method for this stack

    +

    Readonly Internal_versionReportingEnabled

    _versionReportingEnabled: boolean

    Whether version reporting is enabled for this stack

    Controls whether the CDK Metadata resource is injected

    -
    -
    -
    -

    Readonly Internal _crossRegionReferences

    -
    _crossRegionReferences: boolean
    -

    Whether cross region references are enabled for this stack

    -
    -
    -
    -

    Optional Readonly Internal _notificationArns

    -
    _notificationArns?: string[]
    -

    SNS Notification ARNs to receive stack events.

    -
    -
    -
    -

    Readonly node

    -
    node: Node
    -

    The tree node.

    -
    -
    -
    -

    Accessors

    -
    -

    terminationProtection

    -
      -
    • get terminationProtection(): boolean
      • -
    • -

      Whether termination protection is enabled for this stack.

      -
      -

      Returns boolean

      -
      • -
    • set terminationProtection(value): void
      • -
    • -
      -

      Parameters

      -
        -
      • -
        value: boolean
      -

      Returns void

    -
    -

    Private permissionsBoundaryArn

    -
      -
    • get permissionsBoundaryArn(): any
      • -
    • -

      If a permissions boundary has been applied on this scope or any parent scope -then this will return the ARN of the permissions boundary.

      -

      This will return the permissions boundary that has been applied to the most -specific scope.

      -

      For example:

      -

      const stage = new Stage(app, 'stage', { - permissionsBoundary: PermissionsBoundary.fromName('stage-pb'), -});

      -

      const stack = new Stack(stage, 'Stack', { - permissionsBoundary: PermissionsBoundary.fromName('some-other-pb'), -});

      -

      Stack.permissionsBoundaryArn === 'arn:${AWS::Partition}:iam::${AWS::AccountId}:policy/some-other-pb';

      -
      -

      Returns any

      the name of the permissions boundary or undefined if not set

      - -
    -
    -

    dependencies

    -
      -
    • get dependencies(): Stack[]
      • -
    • -

      Return the stacks this stack depends on

      -
      -

      Returns Stack[]

      -
    -
    -

    stackName

    -
      -
    • get stackName(): string
      • -
    • -

      The concrete CloudFormation physical stack name.

      +

    Readonly Internal_crossRegionReferences

    _crossRegionReferences: boolean

    Whether cross region references are enabled for this stack

    +

    Optional Readonly Internal_notificationArns

    _notificationArns?: string[]

    SNS Notification ARNs to receive stack events.

    +

    Readonlynode

    node: Node

    The tree node.

    +

    Accessors

    terminationProtection

    • get terminationProtection(): boolean

    • Whether termination protection is enabled for this stack.

      +

      Returns boolean

    • set terminationProtection(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    dependencies

    • get dependencies(): Stack[]

    • Return the stacks this stack depends on

      +

      Returns Stack[]

    stackName

    • get stackName(): string

    • The concrete CloudFormation physical stack name.

      This is either the name defined explicitly in the stackName prop or -allocated based on the stack's location in the construct tree. Stacks that +allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack name. Stacks that are defined deeper within the tree will use a hashed naming scheme based on the construct path to ensure uniqueness.

      If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.

      -
      -

      Returns string

      -
    -
    -

    partition

    -
      -
    • get partition(): string
      • -
    • -

      The partition in which this stack is defined

      -
      -

      Returns string

      -
    -
    -

    urlSuffix

    -
      -
    • get urlSuffix(): string
      • -
    • -

      The Amazon domain suffix for the region in which this stack is defined

      -
      -

      Returns string

      -
    -
    -

    stackId

    -
      -
    • get stackId(): string
      • -
    • -

      The ID of the stack

      -
      -

      Returns string

      -
      -

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
-
      -
    -
    -

    notificationArns

    -
      -
    • get notificationArns(): string[]
      • -
    • -

      Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      -
      -

      Returns string[]

      -
    -
    -

    nested

    -
      -
    • get nested(): boolean
      • -
    • -

      Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      -
      -

      Returns boolean

      -
    -
    -

    availabilityZones

    -
      -
    • get availabilityZones(): string[]
      • -
    • -

      Returns the list of AZs that are available in the AWS environment +

      Returns string

    partition

    • get partition(): string

    • The partition in which this stack is defined

      +

      Returns string

    urlSuffix

    • get urlSuffix(): string

    • The Amazon domain suffix for the region in which this stack is defined

      +

      Returns string

    stackId

    • get stackId(): string

    • The ID of the stack

      +

      Returns string

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+
      + +

    notificationArns

    • get notificationArns(): string[]

    • Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      +

      Returns string[]

    nested

    • get nested(): boolean

    • Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      +

      Returns boolean

    availabilityZones

    • get availabilityZones(): string[]

    • Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

      If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve -at deploy-time to the first two availability zones returned from CloudFormation's +at deploy-time to the first two availability zones returned from CloudFormation's Fn::GetAZs intrinsic function.

      If they are not available in the context, returns a set of dummy values and reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

      To specify a different strategy for selecting availability zones override this method.

      -
      -

      Returns string[]

      -
    -
    -

    nestedStackParent

    -
      -
    • get nestedStackParent(): undefined | Stack
      • -
    • -

      If this is a nested stack, returns it's parent stack.

      -
      -

      Returns undefined | Stack

      -
    -
    -

    Private maxResources

    -
      -
    • get maxResources(): any
      • -
    • -

      Maximum number of resources in the stack

      -

      Set to 0 to mean "unlimited".

      -
      -

      Returns any

      -
    -
    -

    bundlingRequired

    -
      -
    • get bundlingRequired(): boolean
      • -
    • -

      Indicates whether the stack requires bundling or not

      -
      -

      Returns boolean

      -
    -
    -

    Methods

    -
    -

    Static isStack

    -
      - -
    • -

      Return whether the given object is a Stack.

      -

      We do attribute detection since we can't reliably use 'instanceof'.

      -
      -
      -

      Parameters

      -
        -
      • -
        x: any
      -

      Returns x is Stack

      -
    -
    -

    Static of

    -
      - -
    • -

      Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      -
      -
      -

      Parameters

      -
        -
      • -
        construct: IConstruct
        -

        The construct to start the search from.

        -
        -
      -

      Returns Stack

      -
    -
    -

    resolve

    -
      - -
    • -

      Resolve a tokenized value in the context of the current stack.

      -
      -
      -

      Parameters

      -
        -
      • -
        obj: any
      -

      Returns any

      -
    -
    -

    toJsonString

    -
      - -
    • -

      Convert an object, potentially containing tokens, to a JSON string

      -
      -
      -

      Parameters

      -
        -
      • -
        obj: any
        • -
      • -
        Optional space: number
      -

      Returns string

      -
    -
    -

    toYamlString

    -
      - -
    • -

      Convert an object, potentially containing tokens, to a YAML string

      -
      -
      -

      Parameters

      -
        -
      • -
        obj: any
      -

      Returns string

      -
    -
    -

    reportMissingContextKey

    -
      - -
    • -

      Indicate that a context key was expected

      +

      Returns string[]

    nestedStackParent

    • get nestedStackParent(): undefined | Stack

    • If this is a nested stack, returns it's parent stack.

      +

      Returns undefined | Stack

    bundlingRequired

    • get bundlingRequired(): boolean

    • Indicates whether the stack requires bundling or not

      +

      Returns boolean

    Methods

    StaticisStack

    • isStack(x: any): x is Stack

    • Return whether the given object is a Stack.

      +

      We do attribute detection since we can't reliably use 'instanceof'.

      +

      Parameters

      • x: any

      Returns x is Stack

    Staticof

    • of(construct: IConstruct): Stack

    • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      +

      Parameters

      • construct: IConstruct

        The construct to start the search from.

        +

      Returns Stack

    resolve

    • resolve(obj: any): any

    • Resolve a tokenized value in the context of the current stack.

      +

      Parameters

      • obj: any

      Returns any

    toJsonString

    • toJsonString(obj: any, space?: number): string

    • Convert an object, potentially containing tokens, to a JSON string

      +

      Parameters

      • obj: any
      • Optionalspace: number

      Returns string

    toYamlString

    • toYamlString(obj: any): string

    • Convert an object, potentially containing tokens, to a YAML string

      +

      Parameters

      • obj: any

      Returns string

    reportMissingContextKey

    • reportMissingContextKey(report: MissingContext): void

    • Indicate that a context key was expected

      Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

      -
      -
      -

      Parameters

      -
        -
      • -
        report: MissingContext
        -

        The set of parameters needed to obtain the context

        -
        -
      -

      Returns void

      -
    -
    -

    renameLogicalId

    -
      - -
    • -

      Rename a generated logical identities

      +

      Parameters

      • report: MissingContext

        The set of parameters needed to obtain the context

        +

      Returns void

    renameLogicalId

    • renameLogicalId(oldId: string, newId: string): void

    • Rename a generated logical identities

      To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

      -
      -
      -

      Parameters

      -
        -
      • -
        oldId: string
        • -
      • -
        newId: string
      -

      Returns void

      -
    -
    -

    getLogicalId

    -
      - -
    • -

      Allocates a stack-unique CloudFormation-compatible logical identity for a +

      Parameters

      • oldId: string
      • newId: string

      Returns void

    getLogicalId

    -
    -

    addDependency

    -
      - -
    • -

      Add a dependency between this stack and another stack.

      +

    Returns string

    addDependency

    • addDependency(target: Stack, reason?: string): void

    • Add a dependency between this stack and another stack.

      This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

      -
      -
      -

      Parameters

      -
        -
      • -
        target: Stack
        • -
      • -
        Optional reason: string
      -

      Returns void

      -
    -
    -

    formatArn

    -
      - -
    • -

      Creates an ARN from components.

      -

      If partition, region or account are not specified, the stack's +

      Parameters

      • target: Stack
      • Optionalreason: string

      Returns void

    formatArn

    • formatArn(components: ArnComponents): string

    • Creates an ARN from components.

      +

      If partition, region or account are not specified, the stack's partition, region and account will be used.

      If any component is the empty string, an empty string will be inserted into the generated ARN at the location that component corresponds to.

      The ARN will be formatted as follows:

      -

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      +

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      The required ARN pieces that are omitted will be taken from the stack that -the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope -can be 'undefined'.

      -
      -
      -

      Parameters

      -
        -
      • -
        components: ArnComponents
      -

      Returns string

      -
    -
    -

    splitArn

    -
      - -
    • -

      Splits the provided ARN into its components. -Works both if 'arn' is a string like 'arn:aws:s3:::bucket', +the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope +can be 'undefined'.

      +

      Parameters

      • components: ArnComponents

      Returns string

    splitArn

    • splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

    • Splits the provided ARN into its components. +Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

      -
      -
      -

      Parameters

      -
        -
      • -
        arn: string
        -

        the ARN to split into its components

        -
        -
        • -
      • -
        arnFormat: ArnFormat
        -

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        -
        -
      -

      Returns ArnComponents

      -
    -
    -

    addTransform

    -
      - -
    • -

      Add a Transform to this stack. A Transform is a macro that AWS +

      Parameters

      • arn: string

        the ARN to split into its components

        +
      • arnFormat: ArnFormat

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        +

      Returns ArnComponents

    addTransform

    -
    -

    addMetadata

    -
      - -
    • -

      Adds an arbitrary key-value pair, with information you want to record about the stack. +

    addMetadata

    -
    -

    _addAssemblyDependency

    -

    _addAssemblyDependency

    • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
    • Internal

      Called implicitly by the addDependency helper function in order to realize a dependency between two top-level stacks at the assembly level.

      Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

      -
      -
      -

      Parameters

      -
        -
      • -
        target: Stack
        • -
      • -
        Optional reason: StackDependencyReason
      -

      Returns void

      -
    -
    -

    _obtainAssemblyDependencies

    -
      -
    • _obtainAssemblyDependencies(reasonFilter): Element[]
      • -
    • Internal -

      Called implicitly by the obtainDependencies helper function in order to +

      Parameters

      • target: Stack
      • Optionalreason: StackDependencyReason

      Returns void

    _obtainAssemblyDependencies

    • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
    • Internal

      Called implicitly by the obtainDependencies helper function in order to collect resource dependencies across two top-level stacks at the assembly level.

      Use stack.obtainDependencies to see the dependencies between any two stacks.

      -
      -
      -

      Parameters

      -
        -
      • -
        reasonFilter: StackDependencyReason
      -

      Returns Element[]

      -
    -
    -

    _removeAssemblyDependency

    -
      -
    • _removeAssemblyDependency(target, reasonFilter?): void
      • -
    • Internal -

      Called implicitly by the removeDependency helper function in order to +

      Parameters

      • reasonFilter: StackDependencyReason

      Returns Element[]

    _removeAssemblyDependency

    • _removeAssemblyDependency(
          target: Stack,
          reasonFilter?: StackDependencyReason,
      ): void
    • Internal

      Called implicitly by the removeDependency helper function in order to remove a dependency between two top-level stacks at the assembly level.

      Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

      -
      -
      -

      Parameters

      -
        -
      • -
        target: Stack
        • -
      • -
        Optional reasonFilter: StackDependencyReason
      -

      Returns void

      -
    -
    -

    _synthesizeTemplate

    -
      -
    • _synthesizeTemplate(session, lookupRoleArn?, lookupRoleExternalId?, lookupRoleAdditionalOptions?): void
      • -
    • Internal -

      Synthesizes the cloudformation template into a cloud assembly.

      -
      -
      -

      Parameters

      -
        -
      • -
        session: ISynthesisSession
        • -
      • -
        Optional lookupRoleArn: string
        • -
      • -
        Optional lookupRoleExternalId: string
        • -
      • -
        Optional lookupRoleAdditionalOptions: {
            [key: string]: any;
        }
        -
          -
        • -
          [key: string]: any
      -

      Returns void

      -
    -
    -

    regionalFact

    -
      - -
    • -

      Look up a fact value for the given fact for the region of this stack

      +

      Parameters

      • target: Stack
      • OptionalreasonFilter: StackDependencyReason

      Returns void

    _synthesizeTemplate

    • _synthesizeTemplate(
          session: ISynthesisSession,
          lookupRoleArn?: string,
          lookupRoleExternalId?: string,
          lookupRoleAdditionalOptions?: { [key: string]: any },
      ): void
    • Internal

      Synthesizes the cloudformation template into a cloud assembly.

      +

      Parameters

      • session: ISynthesisSession
      • OptionallookupRoleArn: string
      • OptionallookupRoleExternalId: string
      • OptionallookupRoleAdditionalOptions: { [key: string]: any }

      Returns void

    regionalFact

    -
    -

    exportValue

    -
      - -
    • -

      Create a CloudFormation Export for a string value

      +

      Parameters

      • factName: string
      • OptionaldefaultValue: string

      Returns string

    exportValue

    Deployment 2: remove the bucket resource:

    • You are now free to remove the bucket resource from producerStack.
      • -
    • Don't forget to remove the exportValue() call as well.
      • +
    • Don't forget to remove the exportValue() call as well.
    • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
    -
    -
    -

    Parameters

    -
      -
    • -
      exportedValue: any
      • -
    • -
      Optional options: ExportValueOptions
    -

    Returns string

    -
    -
    -

    exportStringListValue

    -
      - -
    • -

      Create a CloudFormation Export for a string list value

      +

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string

    exportStringListValue

    • exportStringListValue(
          exportedValue: any,
          options?: ExportValueOptions,
      ): string[]

    • Create a CloudFormation Export for a string list value

      Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only export strings. You can control the name for the export by passing the name option.

      -

      If you don't supply a value for name, the value you're exporting must be +

      If you don't supply a value for name, the value you're exporting must be a Resource attribute (for example: bucket.bucketName) and it will be given the same name as the automatic cross-stack reference that would be created if you used the attribute in another Stack.

      @@ -973,25 +270,7 @@

      exportStringListValue remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

      See exportValue for an example of this process.

      -

      -
      -

      Parameters

      -
        -
      • -
        exportedValue: any
        • -
      • -
        Optional options: ExportValueOptions
      -

      Returns string[]

      -
    -
    -

    Protected allocateLogicalId

    -
      - -
    • -

      Returns the naming scheme used to allocate logical IDs. By default, uses +

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string[]

    ProtectedallocateLogicalId

    • allocateLogicalId(cfnElement: CfnElement): string

    • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize this behavior.

      In order to make sure logical IDs are unique and stable, we hash the resource @@ -999,15 +278,15 @@

      Protected

      The result will be:

      -

      <path.join('')><md5(path.join('/')> - "human" "hash"

      +

      <path.join('')><md5(path.join('/')> +"human" "hash"

      If the "human" part of the ID exceeds 240 characters, we simply trim it so -the total ID doesn't exceed CloudFormation's 255 character limit.

      +the total ID doesn't exceed CloudFormation's 255 character limit.

      We only take 8 characters from the md5 hash (0.000005 chance of collision).

      Special cases:

        -
      • If the path only contains a single component (i.e. it's a top-level -resource), we won't add the hash to it. The hash is not needed for +
      • If the path only contains a single component (i.e. it's a top-level +resource), we won't add the hash to it. The hash is not needed for disambiguation and also, it allows for a more straightforward migration an existing CloudFormation template to a CDK stack without logical ID changes (or renames).
        • @@ -1022,58 +301,13 @@

        Protected

      -

      -
      -

      Parameters

      -
        -
      • -
        cfnElement: CfnElement
        -

        The element for which the logical ID is allocated.

        -
        -
      -

      Returns string

      -
    -
    -

    Protected _validateId

    -
      -
    • _validateId(name): void
      • -
    • Internal -

      Validate stack name

      +

      Parameters

      • cfnElement: CfnElement

        The element for which the logical ID is allocated.

        +

      Returns string

    Protected_validateId

    • _validateId(name: string): void
    • Internal

      Validate stack name

      CloudFormation stack names can include dashes in addition to the regular identifier -character classes, and we don't allow one of the magic markers.

      -
      -
      -

      Parameters

      -
        -
      • -
        name: string
      -

      Returns void

      -
    -
    -

    Protected _toCloudFormation

    -
      -
    • _toCloudFormation(): any
      • -
    • Internal -

      Returns the CloudFormation template for this stack by traversing +character classes, and we don't allow one of the magic markers.

      +

      Parameters

      • name: string

      Returns void

    Protected_toCloudFormation

    • _toCloudFormation(): any
    • Internal

      Returns the CloudFormation template for this stack by traversing the tree and invoking _toCloudFormation() on all Entity objects.

      -
      -

      Returns any

      -
    -
    -

    Static isConstruct

    -
      - -
    • -

      Checks if x is a construct.

      +

      Returns any

    StaticisConstruct

    • isConstruct(x: any): x is Construct

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      Explanation: in JavaScript, multiple copies of the constructs library on @@ -1086,122 +320,7 @@

      Static instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

      -

      -
      -

      Parameters

      -
        -
      • -
        x: any
        -

        Any object

        -
        -
      -

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

      - -
    -
    -

    toString

    -
      - -
    • -

      Returns a string representation of this construct.

      -
      -

      Returns string

      -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -

    On This Page

     -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Parameters

    • x: any

      Any object

      +

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

    +

    toString

    • toString(): string

    • Returns a string representation of this construct.

      +

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/EmbeddedLinuxCodebuildProjectStack.html b/classes/EmbeddedLinuxCodebuildProjectStack.html index 88c7564..a39d59f 100644 --- a/classes/EmbeddedLinuxCodebuildProjectStack.html +++ b/classes/EmbeddedLinuxCodebuildProjectStack.html @@ -1,148 +1,58 @@ -EmbeddedLinuxCodebuildProjectStack | aws4embeddedlinux-cdk-lib
    -
    - -
    -
    -
    -
    - -

    Class EmbeddedLinuxCodebuildProjectStack

    -
    -

    The stack for creating a build pipeline.

    +EmbeddedLinuxCodebuildProjectStack | aws4embeddedlinux-cdk-lib

    Class EmbeddedLinuxCodebuildProjectStack

    The stack for creating a build pipeline.

    See EmbeddedLinuxCodebuildProjectProps for configration options.

    -
    -
    -
    -

    Hierarchy

    -
      -
    • Stack -
        -
      • EmbeddedLinuxCodebuildProjectStack
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    constructor -
    -
    -

    Properties

    -
    tags -templateOptions -region -account -environment -nestedStackResource? -templateFile -artifactId -synthesizer -_versionReportingEnabled -_crossRegionReferences -_notificationArns? -node -
    -
    -

    Accessors

    -
    terminationProtection -permissionsBoundaryArn -dependencies -stackName -partition -urlSuffix -stackId -notificationArns -nested -availabilityZones -nestedStackParent -maxResources -bundlingRequired -
    -
    -

    Methods

    -
    addFileSystem -addProjectPolicies -isStack -of -resolve -toJsonString -toYamlString -reportMissingContextKey -renameLogicalId -getLogicalId -addDependency -formatArn -splitArn -addTransform -addMetadata -_addAssemblyDependency -_obtainAssemblyDependencies -_removeAssemblyDependency -_synthesizeTemplate -regionalFact -exportValue -exportStringListValue -allocateLogicalId -_validateId -_toCloudFormation -isConstruct -toString -
    -
    -

    Constructors

    -
    -

    constructor

    -
    -
    -

    Properties

    -
    -

    Readonly tags

    -
    tags: TagManager
    -

    Tags to be applied to the stack.

    -
    -
    -
    -

    Readonly templateOptions

    -
    templateOptions: ITemplateOptions
    -

    Options for CloudFormation template (like version, transform, description).

    -
    -
    -
    -

    Readonly region

    -
    region: string
    -

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    +

    Hierarchy

    • Stack
      • EmbeddedLinuxCodebuildProjectStack

    Constructors

    constructor +

    Properties

    tags +templateOptions +region +account +environment +nestedStackResource? +templateFile +artifactId +synthesizer +_versionReportingEnabled +_crossRegionReferences +_notificationArns? +node +

    Accessors

    terminationProtection +dependencies +stackName +partition +urlSuffix +stackId +notificationArns +nested +availabilityZones +nestedStackParent +bundlingRequired +

    Methods

    isStack +of +resolve +toJsonString +toYamlString +reportMissingContextKey +renameLogicalId +getLogicalId +addDependency +formatArn +splitArn +addTransform +addMetadata +_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate +regionalFact +exportValue +exportStringListValue +allocateLogicalId +_validateId +_toCloudFormation +isConstruct +toString +

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    +

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    1. The value provided to env.region when the stack is defined. This can @@ -159,15 +69,7 @@

      Readonlyregion-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

      -

    -
    -
    -

    Readonly account

    -
    account: string
    -

    The AWS account into which this stack will be deployed.

    +

    Readonlyaccount

    account: string

    The AWS account into which this stack will be deployed.

    This value is resolved according to the following rules:

    1. The value provided to env.account when the stack is defined. This can @@ -184,15 +86,7 @@

      Readonlyaccount-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

      -

    -
    -
    -

    Readonly environment

    -
    environment: string
    -

    The environment coordinates in which this stack is deployed. In the form +

    Readonlyenvironment

    environment: string

    The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

    You can use this value to determine if two stacks are targeting the same @@ -201,468 +95,63 @@

    ReadonlyAws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

    -

    -
    -
    -

    Optional Readonly nestedStackResource

    -
    nestedStackResource?: CfnResource
    -

    If this is a nested stack, this represents its AWS::CloudFormation::Stack +

    Optional ReadonlynestedStackResource

    nestedStackResource?: CfnResource

    If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

    -
    -
    -
    -

    Readonly templateFile

    -
    templateFile: string
    -

    The name of the CloudFormation template file emitted to the output +

    ReadonlytemplateFile

    templateFile: string

    The name of the CloudFormation template file emitted to the output directory during synthesis.

    Example value: MyStack.template.json

    -
    -
    -
    -

    Readonly artifactId

    -
    artifactId: string
    -

    The ID of the cloud assembly artifact for this stack.

    -
    -
    -
    -

    Readonly synthesizer

    -
    synthesizer: IStackSynthesizer
    -

    Synthesis method for this stack

    -
    -
    -
    -

    Readonly Internal _versionReportingEnabled

    -
    _versionReportingEnabled: boolean
    -

    Whether version reporting is enabled for this stack

    +

    ReadonlyartifactId

    artifactId: string

    The ID of the cloud assembly artifact for this stack.

    +

    Readonlysynthesizer

    synthesizer: IStackSynthesizer

    Synthesis method for this stack

    +

    Readonly Internal_versionReportingEnabled

    _versionReportingEnabled: boolean

    Whether version reporting is enabled for this stack

    Controls whether the CDK Metadata resource is injected

    -
    -
    -
    -

    Readonly Internal _crossRegionReferences

    -
    _crossRegionReferences: boolean
    -

    Whether cross region references are enabled for this stack

    -
    -
    -
    -

    Optional Readonly Internal _notificationArns

    -
    _notificationArns?: string[]
    -

    SNS Notification ARNs to receive stack events.

    -
    -
    -
    -

    Readonly node

    -
    node: Node
    -

    The tree node.

    -
    -
    -
    -

    Accessors

    -
    -

    terminationProtection

    -
      -
    • get terminationProtection(): boolean
      • -
    • -

      Whether termination protection is enabled for this stack.

      -
      -

      Returns boolean

      -
      • -
    • set terminationProtection(value): void
      • -
    • -
      -

      Parameters

      -
        -
      • -
        value: boolean
      -

      Returns void

    -
    -

    Private permissionsBoundaryArn

    -
      -
    • get permissionsBoundaryArn(): any
      • -
    • -

      If a permissions boundary has been applied on this scope or any parent scope -then this will return the ARN of the permissions boundary.

      -

      This will return the permissions boundary that has been applied to the most -specific scope.

      -

      For example:

      -

      const stage = new Stage(app, 'stage', { - permissionsBoundary: PermissionsBoundary.fromName('stage-pb'), -});

      -

      const stack = new Stack(stage, 'Stack', { - permissionsBoundary: PermissionsBoundary.fromName('some-other-pb'), -});

      -

      Stack.permissionsBoundaryArn === 'arn:${AWS::Partition}:iam::${AWS::AccountId}:policy/some-other-pb';

      -
      -

      Returns any

      the name of the permissions boundary or undefined if not set

      - -
    -
    -

    dependencies

    -
      -
    • get dependencies(): Stack[]
      • -
    • -

      Return the stacks this stack depends on

      -
      -

      Returns Stack[]

      -
    -
    -

    stackName

    -
      -
    • get stackName(): string
      • -
    • -

      The concrete CloudFormation physical stack name.

      +

    Readonly Internal_crossRegionReferences

    _crossRegionReferences: boolean

    Whether cross region references are enabled for this stack

    +

    Optional Readonly Internal_notificationArns

    _notificationArns?: string[]

    SNS Notification ARNs to receive stack events.

    +

    Readonlynode

    node: Node

    The tree node.

    +

    Accessors

    terminationProtection

    • get terminationProtection(): boolean

    • Whether termination protection is enabled for this stack.

      +

      Returns boolean

    • set terminationProtection(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    dependencies

    • get dependencies(): Stack[]

    • Return the stacks this stack depends on

      +

      Returns Stack[]

    stackName

    • get stackName(): string

    • The concrete CloudFormation physical stack name.

      This is either the name defined explicitly in the stackName prop or -allocated based on the stack's location in the construct tree. Stacks that +allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack name. Stacks that are defined deeper within the tree will use a hashed naming scheme based on the construct path to ensure uniqueness.

      If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.

      -
      -

      Returns string

      -
    -
    -

    partition

    -
      -
    • get partition(): string
      • -
    • -

      The partition in which this stack is defined

      -
      -

      Returns string

      -
    -
    -

    urlSuffix

    -
      -
    • get urlSuffix(): string
      • -
    • -

      The Amazon domain suffix for the region in which this stack is defined

      -
      -

      Returns string

      -
    -
    -

    stackId

    -
      -
    • get stackId(): string
      • -
    • -

      The ID of the stack

      -
      -

      Returns string

      -
      -

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
-
      -
    -
    -

    notificationArns

    -
      -
    • get notificationArns(): string[]
      • -
    • -

      Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      -
      -

      Returns string[]

      -
    -
    -

    nested

    -
      -
    • get nested(): boolean
      • -
    • -

      Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      -
      -

      Returns boolean

      -
    -
    -

    availabilityZones

    -
      -
    • get availabilityZones(): string[]
      • -
    • -

      Returns the list of AZs that are available in the AWS environment +

      Returns string

    partition

    • get partition(): string

    • The partition in which this stack is defined

      +

      Returns string

    urlSuffix

    • get urlSuffix(): string

    • The Amazon domain suffix for the region in which this stack is defined

      +

      Returns string

    stackId

    • get stackId(): string

    • The ID of the stack

      +

      Returns string

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+
      + +

    notificationArns

    • get notificationArns(): string[]

    • Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      +

      Returns string[]

    nested

    • get nested(): boolean

    • Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      +

      Returns boolean

    availabilityZones

    • get availabilityZones(): string[]

    • Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

      If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve -at deploy-time to the first two availability zones returned from CloudFormation's +at deploy-time to the first two availability zones returned from CloudFormation's Fn::GetAZs intrinsic function.

      If they are not available in the context, returns a set of dummy values and reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

      To specify a different strategy for selecting availability zones override this method.

      -
      -

      Returns string[]

      -
    -
    -

    nestedStackParent

    -
      -
    • get nestedStackParent(): undefined | Stack
      • -
    • -

      If this is a nested stack, returns it's parent stack.

      -
      -

      Returns undefined | Stack

      -
    -
    -

    Private maxResources

    -
      -
    • get maxResources(): any
      • -
    • -

      Maximum number of resources in the stack

      -

      Set to 0 to mean "unlimited".

      -
      -

      Returns any

      -
    -
    -

    bundlingRequired

    -
      -
    • get bundlingRequired(): boolean
      • -
    • -

      Indicates whether the stack requires bundling or not

      -
      -

      Returns boolean

      -
    -
    -

    Methods

    -
    -

    Private addFileSystem

    -
      - -
    • -

      Adds an EFS FileSystem to the VPC and SecurityGroup.

      -
      -
      -

      Parameters

      -
        -
      • -
        name: string
        -

        A name to differentiate the filesystem.

        -
        -
        • -
      • -
        vpc: IVpc
        -

        The VPC the Filesystem resides in.

        -
        -
        • -
      • -
        securityGroup: ISecurityGroup
        -

        A SecurityGroup to allow access to the filesystem from.

        -
        -
      -

      Returns string

      The filesystem location URL.

      - -
    -
    -

    Private addProjectPolicies

    -
    -
    -

    Static isStack

    -
      - -
    • -

      Return whether the given object is a Stack.

      -

      We do attribute detection since we can't reliably use 'instanceof'.

      -
      -
      -

      Parameters

      -
        -
      • -
        x: any
      -

      Returns x is Stack

      -
    -
    -

    Static of

    -
      - -
    • -

      Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      -
      -
      -

      Parameters

      -
        -
      • -
        construct: IConstruct
        -

        The construct to start the search from.

        -
        -
      -

      Returns Stack

      -
    -
    -

    resolve

    -
      - -
    • -

      Resolve a tokenized value in the context of the current stack.

      -
      -
      -

      Parameters

      -
        -
      • -
        obj: any
      -

      Returns any

      -
    -
    -

    toJsonString

    -
      - -
    • -

      Convert an object, potentially containing tokens, to a JSON string

      -
      -
      -

      Parameters

      -
        -
      • -
        obj: any
        • -
      • -
        Optional space: number
      -

      Returns string

      -
    -
    -

    toYamlString

    -
      - -
    • -

      Convert an object, potentially containing tokens, to a YAML string

      -
      -
      -

      Parameters

      -
        -
      • -
        obj: any
      -

      Returns string

      -
    -
    -

    reportMissingContextKey

    -
      - -
    • -

      Indicate that a context key was expected

      +

      Returns string[]

    nestedStackParent

    • get nestedStackParent(): undefined | Stack

    • If this is a nested stack, returns it's parent stack.

      +

      Returns undefined | Stack

    bundlingRequired

    • get bundlingRequired(): boolean

    • Indicates whether the stack requires bundling or not

      +

      Returns boolean

    Methods

    StaticisStack

    • isStack(x: any): x is Stack

    • Return whether the given object is a Stack.

      +

      We do attribute detection since we can't reliably use 'instanceof'.

      +

      Parameters

      • x: any

      Returns x is Stack

    Staticof

    • of(construct: IConstruct): Stack

    • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      +

      Parameters

      • construct: IConstruct

        The construct to start the search from.

        +

      Returns Stack

    resolve

    • resolve(obj: any): any

    • Resolve a tokenized value in the context of the current stack.

      +

      Parameters

      • obj: any

      Returns any

    toJsonString

    • toJsonString(obj: any, space?: number): string

    • Convert an object, potentially containing tokens, to a JSON string

      +

      Parameters

      • obj: any
      • Optionalspace: number

      Returns string

    toYamlString

    • toYamlString(obj: any): string

    • Convert an object, potentially containing tokens, to a YAML string

      +

      Parameters

      • obj: any

      Returns string

    reportMissingContextKey

    • reportMissingContextKey(report: MissingContext): void

    • Indicate that a context key was expected

      Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

      -
      -
      -

      Parameters

      -
        -
      • -
        report: MissingContext
        -

        The set of parameters needed to obtain the context

        -
        -
      -

      Returns void

      -
    -
    -

    renameLogicalId

    -
      - -
    • -

      Rename a generated logical identities

      +

      Parameters

      • report: MissingContext

        The set of parameters needed to obtain the context

        +

      Returns void

    renameLogicalId

    • renameLogicalId(oldId: string, newId: string): void

    • Rename a generated logical identities

      To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

      -
      -
      -

      Parameters

      -
        -
      • -
        oldId: string
        • -
      • -
        newId: string
      -

      Returns void

      -
    -
    -

    getLogicalId

    -
      - -
    • -

      Allocates a stack-unique CloudFormation-compatible logical identity for a +

      Parameters

      • oldId: string
      • newId: string

      Returns void

    getLogicalId

    -
    -

    addDependency

    -
      - -
    • -

      Add a dependency between this stack and another stack.

      +

    Returns string

    addDependency

    • addDependency(target: Stack, reason?: string): void

    • Add a dependency between this stack and another stack.

      This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

      -
      -
      -

      Parameters

      -
        -
      • -
        target: Stack
        • -
      • -
        Optional reason: string
      -

      Returns void

      -
    -
    -

    formatArn

    -
      - -
    • -

      Creates an ARN from components.

      -

      If partition, region or account are not specified, the stack's +

      Parameters

      • target: Stack
      • Optionalreason: string

      Returns void

    formatArn

    • formatArn(components: ArnComponents): string

    • Creates an ARN from components.

      +

      If partition, region or account are not specified, the stack's partition, region and account will be used.

      If any component is the empty string, an empty string will be inserted into the generated ARN at the location that component corresponds to.

      The ARN will be formatted as follows:

      -

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      +

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      The required ARN pieces that are omitted will be taken from the stack that -the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope -can be 'undefined'.

      -
      -
      -

      Parameters

      -
        -
      • -
        components: ArnComponents
      -

      Returns string

      -
    -
    -

    splitArn

    -
      - -
    • -

      Splits the provided ARN into its components. -Works both if 'arn' is a string like 'arn:aws:s3:::bucket', +the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope +can be 'undefined'.

      +

      Parameters

      • components: ArnComponents

      Returns string

    splitArn

    • splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

    • Splits the provided ARN into its components. +Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

      -
      -
      -

      Parameters

      -
        -
      • -
        arn: string
        -

        the ARN to split into its components

        -
        -
        • -
      • -
        arnFormat: ArnFormat
        -

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        -
        -
      -

      Returns ArnComponents

      -
    -
    -

    addTransform

    -
      - -
    • -

      Add a Transform to this stack. A Transform is a macro that AWS +

      Parameters

      • arn: string

        the ARN to split into its components

        +
      • arnFormat: ArnFormat

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        +

      Returns ArnComponents

    addTransform

    -
    -

    addMetadata

    -
      - -
    • -

      Adds an arbitrary key-value pair, with information you want to record about the stack. +

    addMetadata

    -
    -

    _addAssemblyDependency

    -

    _addAssemblyDependency

    • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
    • Internal

      Called implicitly by the addDependency helper function in order to realize a dependency between two top-level stacks at the assembly level.

      Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

      -
      -
      -

      Parameters

      -
        -
      • -
        target: Stack
        • -
      • -
        Optional reason: StackDependencyReason
      -

      Returns void

      -
    -
    -

    _obtainAssemblyDependencies

    -
      -
    • _obtainAssemblyDependencies(reasonFilter): Element[]
      • -
    • Internal -

      Called implicitly by the obtainDependencies helper function in order to +

      Parameters

      • target: Stack
      • Optionalreason: StackDependencyReason

      Returns void

    _obtainAssemblyDependencies

    • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
    • Internal

      Called implicitly by the obtainDependencies helper function in order to collect resource dependencies across two top-level stacks at the assembly level.

      Use stack.obtainDependencies to see the dependencies between any two stacks.

      -
      -
      -

      Parameters

      -
        -
      • -
        reasonFilter: StackDependencyReason
      -

      Returns Element[]

      -
    -
    -

    _removeAssemblyDependency

    -
      -
    • _removeAssemblyDependency(target, reasonFilter?): void
      • -
    • Internal -

      Called implicitly by the removeDependency helper function in order to +

      Parameters

      • reasonFilter: StackDependencyReason

      Returns Element[]

    _removeAssemblyDependency

    • _removeAssemblyDependency(
          target: Stack,
          reasonFilter?: StackDependencyReason,
      ): void
    • Internal

      Called implicitly by the removeDependency helper function in order to remove a dependency between two top-level stacks at the assembly level.

      Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

      -
      -
      -

      Parameters

      -
        -
      • -
        target: Stack
        • -
      • -
        Optional reasonFilter: StackDependencyReason
      -

      Returns void

      -
    -
    -

    _synthesizeTemplate

    -
      -
    • _synthesizeTemplate(session, lookupRoleArn?, lookupRoleExternalId?, lookupRoleAdditionalOptions?): void
      • -
    • Internal -

      Synthesizes the cloudformation template into a cloud assembly.

      -
      -
      -

      Parameters

      -
        -
      • -
        session: ISynthesisSession
        • -
      • -
        Optional lookupRoleArn: string
        • -
      • -
        Optional lookupRoleExternalId: string
        • -
      • -
        Optional lookupRoleAdditionalOptions: {
            [key: string]: any;
        }
        -
          -
        • -
          [key: string]: any
      -

      Returns void

      -
    -
    -

    regionalFact

    -
      - -
    • -

      Look up a fact value for the given fact for the region of this stack

      +

      Parameters

      • target: Stack
      • OptionalreasonFilter: StackDependencyReason

      Returns void

    _synthesizeTemplate

    • _synthesizeTemplate(
          session: ISynthesisSession,
          lookupRoleArn?: string,
          lookupRoleExternalId?: string,
          lookupRoleAdditionalOptions?: { [key: string]: any },
      ): void
    • Internal

      Synthesizes the cloudformation template into a cloud assembly.

      +

      Parameters

      • session: ISynthesisSession
      • OptionallookupRoleArn: string
      • OptionallookupRoleExternalId: string
      • OptionallookupRoleAdditionalOptions: { [key: string]: any }

      Returns void

    regionalFact

    -
    -

    exportValue

    -
      - -
    • -

      Create a CloudFormation Export for a string value

      +

      Parameters

      • factName: string
      • OptionaldefaultValue: string

      Returns string

    exportValue

    Deployment 2: remove the bucket resource:

    • You are now free to remove the bucket resource from producerStack.
      • -
    • Don't forget to remove the exportValue() call as well.
      • +
    • Don't forget to remove the exportValue() call as well.
    • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
    -
    -
    -

    Parameters

    -
      -
    • -
      exportedValue: any
      • -
    • -
      Optional options: ExportValueOptions
    -

    Returns string

    -
    -
    -

    exportStringListValue

    -
      - -
    • -

      Create a CloudFormation Export for a string list value

      +

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string

    exportStringListValue

    • exportStringListValue(
          exportedValue: any,
          options?: ExportValueOptions,
      ): string[]

    • Create a CloudFormation Export for a string list value

      Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only export strings. You can control the name for the export by passing the name option.

      -

      If you don't supply a value for name, the value you're exporting must be +

      If you don't supply a value for name, the value you're exporting must be a Resource attribute (for example: bucket.bucketName) and it will be given the same name as the automatic cross-stack reference that would be created if you used the attribute in another Stack.

      @@ -1004,25 +268,7 @@

      exportStringListValue remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

      See exportValue for an example of this process.

      -

      -
      -

      Parameters

      -
        -
      • -
        exportedValue: any
        • -
      • -
        Optional options: ExportValueOptions
      -

      Returns string[]

      -
    -
    -

    Protected allocateLogicalId

    -
      - -
    • -

      Returns the naming scheme used to allocate logical IDs. By default, uses +

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string[]

    ProtectedallocateLogicalId

    • allocateLogicalId(cfnElement: CfnElement): string

    • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize this behavior.

      In order to make sure logical IDs are unique and stable, we hash the resource @@ -1030,15 +276,15 @@

      Protected

      The result will be:

      -

      <path.join('')><md5(path.join('/')> - "human" "hash"

      +

      <path.join('')><md5(path.join('/')> +"human" "hash"

      If the "human" part of the ID exceeds 240 characters, we simply trim it so -the total ID doesn't exceed CloudFormation's 255 character limit.

      +the total ID doesn't exceed CloudFormation's 255 character limit.

      We only take 8 characters from the md5 hash (0.000005 chance of collision).

      Special cases:

        -
      • If the path only contains a single component (i.e. it's a top-level -resource), we won't add the hash to it. The hash is not needed for +
      • If the path only contains a single component (i.e. it's a top-level +resource), we won't add the hash to it. The hash is not needed for disambiguation and also, it allows for a more straightforward migration an existing CloudFormation template to a CDK stack without logical ID changes (or renames).
        • @@ -1053,58 +299,13 @@

        Protected

      -

      -
      -

      Parameters

      -
        -
      • -
        cfnElement: CfnElement
        -

        The element for which the logical ID is allocated.

        -
        -
      -

      Returns string

      -
    -
    -

    Protected _validateId

    -
      -
    • _validateId(name): void
      • -
    • Internal -

      Validate stack name

      +

      Parameters

      • cfnElement: CfnElement

        The element for which the logical ID is allocated.

        +

      Returns string

    Protected_validateId

    • _validateId(name: string): void
    • Internal

      Validate stack name

      CloudFormation stack names can include dashes in addition to the regular identifier -character classes, and we don't allow one of the magic markers.

      -
      -
      -

      Parameters

      -
        -
      • -
        name: string
      -

      Returns void

      -
    -
    -

    Protected _toCloudFormation

    -
      -
    • _toCloudFormation(): any
      • -
    • Internal -

      Returns the CloudFormation template for this stack by traversing +character classes, and we don't allow one of the magic markers.

      +

      Parameters

      • name: string

      Returns void

    Protected_toCloudFormation

    • _toCloudFormation(): any
    • Internal

      Returns the CloudFormation template for this stack by traversing the tree and invoking _toCloudFormation() on all Entity objects.

      -
      -

      Returns any

      -
    -
    -

    Static isConstruct

    -
      - -
    • -

      Checks if x is a construct.

      +

      Returns any

    StaticisConstruct

    • isConstruct(x: any): x is Construct

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      Explanation: in JavaScript, multiple copies of the constructs library on @@ -1117,123 +318,7 @@

      Static instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

      -

      -
      -

      Parameters

      -
        -
      • -
        x: any
        -

        Any object

        -
        -
      -

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

      - -
    -
    -

    toString

    -
      - -
    • -

      Returns a string representation of this construct.

      -
      -

      Returns string

      -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -

    On This Page

     -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Parameters

    • x: any

      Any object

      +

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

    +

    toString

    • toString(): string

    • Returns a string representation of this construct.

      +

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/EmbeddedLinuxPipelineStack.html b/classes/EmbeddedLinuxPipelineStack.html index 11a2234..7e82dcf 100644 --- a/classes/EmbeddedLinuxPipelineStack.html +++ b/classes/EmbeddedLinuxPipelineStack.html @@ -1,152 +1,58 @@ -EmbeddedLinuxPipelineStack | aws4embeddedlinux-cdk-lib
    -
    - -
    -
    -
    -
    - -

    Class EmbeddedLinuxPipelineStack

    -
    -

    The stack for creating a build pipeline.

    +EmbeddedLinuxPipelineStack | aws4embeddedlinux-cdk-lib

    Class EmbeddedLinuxPipelineStack

    The stack for creating a build pipeline.

    See EmbeddedLinuxPipelineProps for configration options.

    -
    -
    -
    -

    Hierarchy

    -
      -
    • Stack -
        -
      • EmbeddedLinuxPipelineStack
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    constructor -
    -
    -

    Properties

    -
    tags -templateOptions -region -account -environment -nestedStackResource? -templateFile -artifactId -synthesizer -_versionReportingEnabled -_crossRegionReferences -_notificationArns? -node -
    -
    -

    Accessors

    -
    terminationProtection -permissionsBoundaryArn -dependencies -stackName -partition -urlSuffix -stackId -notificationArns -nested -availabilityZones -nestedStackParent -maxResources -bundlingRequired -
    -
    -

    Methods

    -
    addFileSystem -addVMExportPolicy -addAMIS3BackupPolicy -addAMIEBSBackupPolicy -addAMIBackupPolicy -addAMIEC2EBSBackupPolicy -isStack -of -resolve -toJsonString -toYamlString -reportMissingContextKey -renameLogicalId -getLogicalId -addDependency -formatArn -splitArn -addTransform -addMetadata -_addAssemblyDependency -_obtainAssemblyDependencies -_removeAssemblyDependency -_synthesizeTemplate -regionalFact -exportValue -exportStringListValue -allocateLogicalId -_validateId -_toCloudFormation -isConstruct -toString -
    -
    -

    Constructors

    -
    -

    constructor

    -
    -
    -

    Properties

    -
    -

    Readonly tags

    -
    tags: TagManager
    -

    Tags to be applied to the stack.

    -
    -
    -
    -

    Readonly templateOptions

    -
    templateOptions: ITemplateOptions
    -

    Options for CloudFormation template (like version, transform, description).

    -
    -
    -
    -

    Readonly region

    -
    region: string
    -

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    +

    Hierarchy

    • Stack
      • EmbeddedLinuxPipelineStack

    Constructors

    constructor +

    Properties

    tags +templateOptions +region +account +environment +nestedStackResource? +templateFile +artifactId +synthesizer +_versionReportingEnabled +_crossRegionReferences +_notificationArns? +node +

    Accessors

    terminationProtection +dependencies +stackName +partition +urlSuffix +stackId +notificationArns +nested +availabilityZones +nestedStackParent +bundlingRequired +

    Methods

    isStack +of +resolve +toJsonString +toYamlString +reportMissingContextKey +renameLogicalId +getLogicalId +addDependency +formatArn +splitArn +addTransform +addMetadata +_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate +regionalFact +exportValue +exportStringListValue +allocateLogicalId +_validateId +_toCloudFormation +isConstruct +toString +

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    +

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    1. The value provided to env.region when the stack is defined. This can @@ -163,15 +69,7 @@

      Readonlyregion-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

      -

    -
    -
    -

    Readonly account

    -
    account: string
    -

    The AWS account into which this stack will be deployed.

    +

    Readonlyaccount

    account: string

    The AWS account into which this stack will be deployed.

    This value is resolved according to the following rules:

    1. The value provided to env.account when the stack is defined. This can @@ -188,15 +86,7 @@

      Readonlyaccount-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

      -

    -
    -
    -

    Readonly environment

    -
    environment: string
    -

    The environment coordinates in which this stack is deployed. In the form +

    Readonlyenvironment

    environment: string

    The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

    You can use this value to determine if two stacks are targeting the same @@ -205,515 +95,63 @@

    ReadonlyAws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

    -

    -
    -
    -

    Optional Readonly nestedStackResource

    -
    nestedStackResource?: CfnResource
    -

    If this is a nested stack, this represents its AWS::CloudFormation::Stack +

    Optional ReadonlynestedStackResource

    nestedStackResource?: CfnResource

    If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

    -
    -
    -
    -

    Readonly templateFile

    -
    templateFile: string
    -

    The name of the CloudFormation template file emitted to the output +

    ReadonlytemplateFile

    templateFile: string

    The name of the CloudFormation template file emitted to the output directory during synthesis.

    Example value: MyStack.template.json

    -
    -
    -
    -

    Readonly artifactId

    -
    artifactId: string
    -

    The ID of the cloud assembly artifact for this stack.

    -
    -
    -
    -

    Readonly synthesizer

    -
    synthesizer: IStackSynthesizer
    -

    Synthesis method for this stack

    -
    -
    -
    -

    Readonly Internal _versionReportingEnabled

    -
    _versionReportingEnabled: boolean
    -

    Whether version reporting is enabled for this stack

    +

    ReadonlyartifactId

    artifactId: string

    The ID of the cloud assembly artifact for this stack.

    +

    Readonlysynthesizer

    synthesizer: IStackSynthesizer

    Synthesis method for this stack

    +

    Readonly Internal_versionReportingEnabled

    _versionReportingEnabled: boolean

    Whether version reporting is enabled for this stack

    Controls whether the CDK Metadata resource is injected

    -
    -
    -
    -

    Readonly Internal _crossRegionReferences

    -
    _crossRegionReferences: boolean
    -

    Whether cross region references are enabled for this stack

    -
    -
    -
    -

    Optional Readonly Internal _notificationArns

    -
    _notificationArns?: string[]
    -

    SNS Notification ARNs to receive stack events.

    -
    -
    -
    -

    Readonly node

    -
    node: Node
    -

    The tree node.

    -
    -
    -
    -

    Accessors

    -
    -

    terminationProtection

    -
      -
    • get terminationProtection(): boolean
      • -
    • -

      Whether termination protection is enabled for this stack.

      -
      -

      Returns boolean

      -
      • -
    • set terminationProtection(value): void
      • -
    • -
      -

      Parameters

      -
        -
      • -
        value: boolean
      -

      Returns void

    -
    -

    Private permissionsBoundaryArn

    -
      -
    • get permissionsBoundaryArn(): any
      • -
    • -

      If a permissions boundary has been applied on this scope or any parent scope -then this will return the ARN of the permissions boundary.

      -

      This will return the permissions boundary that has been applied to the most -specific scope.

      -

      For example:

      -

      const stage = new Stage(app, 'stage', { - permissionsBoundary: PermissionsBoundary.fromName('stage-pb'), -});

      -

      const stack = new Stack(stage, 'Stack', { - permissionsBoundary: PermissionsBoundary.fromName('some-other-pb'), -});

      -

      Stack.permissionsBoundaryArn === 'arn:${AWS::Partition}:iam::${AWS::AccountId}:policy/some-other-pb';

      -
      -

      Returns any

      the name of the permissions boundary or undefined if not set

      - -
    -
    -

    dependencies

    -
      -
    • get dependencies(): Stack[]
      • -
    • -

      Return the stacks this stack depends on

      -
      -

      Returns Stack[]

      -
    -
    -

    stackName

    -
      -
    • get stackName(): string
      • -
    • -

      The concrete CloudFormation physical stack name.

      +

    Readonly Internal_crossRegionReferences

    _crossRegionReferences: boolean

    Whether cross region references are enabled for this stack

    +

    Optional Readonly Internal_notificationArns

    _notificationArns?: string[]

    SNS Notification ARNs to receive stack events.

    +

    Readonlynode

    node: Node

    The tree node.

    +

    Accessors

    terminationProtection

    • get terminationProtection(): boolean

    • Whether termination protection is enabled for this stack.

      +

      Returns boolean

    • set terminationProtection(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    dependencies

    • get dependencies(): Stack[]

    • Return the stacks this stack depends on

      +

      Returns Stack[]

    stackName

    • get stackName(): string

    • The concrete CloudFormation physical stack name.

      This is either the name defined explicitly in the stackName prop or -allocated based on the stack's location in the construct tree. Stacks that +allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack name. Stacks that are defined deeper within the tree will use a hashed naming scheme based on the construct path to ensure uniqueness.

      If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.

      -
      -

      Returns string

      -
    -
    -

    partition

    -
      -
    • get partition(): string
      • -
    • -

      The partition in which this stack is defined

      -
      -

      Returns string

      -
    -
    -

    urlSuffix

    -
      -
    • get urlSuffix(): string
      • -
    • -

      The Amazon domain suffix for the region in which this stack is defined

      -
      -

      Returns string

      -
    -
    -

    stackId

    -
      -
    • get stackId(): string
      • -
    • -

      The ID of the stack

      -
      -

      Returns string

      -
      -

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
-
      -
    -
    -

    notificationArns

    -
      -
    • get notificationArns(): string[]
      • -
    • -

      Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      -
      -

      Returns string[]

      -
    -
    -

    nested

    -
      -
    • get nested(): boolean
      • -
    • -

      Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      -
      -

      Returns boolean

      -
    -
    -

    availabilityZones

    -
      -
    • get availabilityZones(): string[]
      • -
    • -

      Returns the list of AZs that are available in the AWS environment +

      Returns string

    partition

    • get partition(): string

    • The partition in which this stack is defined

      +

      Returns string

    urlSuffix

    • get urlSuffix(): string

    • The Amazon domain suffix for the region in which this stack is defined

      +

      Returns string

    stackId

    • get stackId(): string

    • The ID of the stack

      +

      Returns string

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+
      + +

    notificationArns

    • get notificationArns(): string[]

    • Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      +

      Returns string[]

    nested

    • get nested(): boolean

    • Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      +

      Returns boolean

    availabilityZones

    • get availabilityZones(): string[]

    • Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

      If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve -at deploy-time to the first two availability zones returned from CloudFormation's +at deploy-time to the first two availability zones returned from CloudFormation's Fn::GetAZs intrinsic function.

      If they are not available in the context, returns a set of dummy values and reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

      To specify a different strategy for selecting availability zones override this method.

      -
      -

      Returns string[]

      -
    -
    -

    nestedStackParent

    -
      -
    • get nestedStackParent(): undefined | Stack
      • -
    • -

      If this is a nested stack, returns it's parent stack.

      -
      -

      Returns undefined | Stack

      -
    -
    -

    Private maxResources

    -
      -
    • get maxResources(): any
      • -
    • -

      Maximum number of resources in the stack

      -

      Set to 0 to mean "unlimited".

      -
      -

      Returns any

      -
    -
    -

    bundlingRequired

    -
      -
    • get bundlingRequired(): boolean
      • -
    • -

      Indicates whether the stack requires bundling or not

      -
      -

      Returns boolean

      -
    -
    -

    Methods

    -
    -

    Private addFileSystem

    -
      - -
    • -

      Adds an EFS FileSystem to the VPC and SecurityGroup.

      -
      -
      -

      Parameters

      -
        -
      • -
        name: string
        -

        A name to differentiate the filesystem.

        -
        -
        • -
      • -
        vpc: IVpc
        -

        The VPC the Filesystem resides in.

        -
        -
        • -
      • -
        securityGroup: ISecurityGroup
        -

        A SecurityGroup to allow access to the filesystem from.

        -
        -
      -

      Returns string

      The filesystem location URL.

      - -
    -
    -

    Private addVMExportPolicy

    -
    -
    -

    Private addAMIS3BackupPolicy

    -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        artifactBucketArn: string
      -

      Returns PolicyStatement

    -
    -

    Private addAMIEBSBackupPolicy

    -
    -
    -

    Private addAMIBackupPolicy

    -
    -
    -

    Private addAMIEC2EBSBackupPolicy

    -
    -
    -

    Static isStack

    -
      - -
    • -

      Return whether the given object is a Stack.

      -

      We do attribute detection since we can't reliably use 'instanceof'.

      -
      -
      -

      Parameters

      -
        -
      • -
        x: any
      -

      Returns x is Stack

      -
    -
    -

    Static of

    -
      - -
    • -

      Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      -
      -
      -

      Parameters

      -
        -
      • -
        construct: IConstruct
        -

        The construct to start the search from.

        -
        -
      -

      Returns Stack

      -
    -
    -

    resolve

    -
      - -
    • -

      Resolve a tokenized value in the context of the current stack.

      -
      -
      -

      Parameters

      -
        -
      • -
        obj: any
      -

      Returns any

      -
    -
    -

    toJsonString

    -
      - -
    • -

      Convert an object, potentially containing tokens, to a JSON string

      -
      -
      -

      Parameters

      -
        -
      • -
        obj: any
        • -
      • -
        Optional space: number
      -

      Returns string

      -
    -
    -

    toYamlString

    -
      - -
    • -

      Convert an object, potentially containing tokens, to a YAML string

      -
      -
      -

      Parameters

      -
        -
      • -
        obj: any
      -

      Returns string

      -
    -
    -

    reportMissingContextKey

    -
      - -
    • -

      Indicate that a context key was expected

      +

      Returns string[]

    nestedStackParent

    • get nestedStackParent(): undefined | Stack

    • If this is a nested stack, returns it's parent stack.

      +

      Returns undefined | Stack

    bundlingRequired

    • get bundlingRequired(): boolean

    • Indicates whether the stack requires bundling or not

      +

      Returns boolean

    Methods

    StaticisStack

    • isStack(x: any): x is Stack

    • Return whether the given object is a Stack.

      +

      We do attribute detection since we can't reliably use 'instanceof'.

      +

      Parameters

      • x: any

      Returns x is Stack

    Staticof

    • of(construct: IConstruct): Stack

    • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      +

      Parameters

      • construct: IConstruct

        The construct to start the search from.

        +

      Returns Stack

    resolve

    • resolve(obj: any): any

    • Resolve a tokenized value in the context of the current stack.

      +

      Parameters

      • obj: any

      Returns any

    toJsonString

    • toJsonString(obj: any, space?: number): string

    • Convert an object, potentially containing tokens, to a JSON string

      +

      Parameters

      • obj: any
      • Optionalspace: number

      Returns string

    toYamlString

    • toYamlString(obj: any): string

    • Convert an object, potentially containing tokens, to a YAML string

      +

      Parameters

      • obj: any

      Returns string

    reportMissingContextKey

    • reportMissingContextKey(report: MissingContext): void

    • Indicate that a context key was expected

      Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

      -
      -
      -

      Parameters

      -
        -
      • -
        report: MissingContext
        -

        The set of parameters needed to obtain the context

        -
        -
      -

      Returns void

      -
    -
    -

    renameLogicalId

    -
      - -
    • -

      Rename a generated logical identities

      +

      Parameters

      • report: MissingContext

        The set of parameters needed to obtain the context

        +

      Returns void

    renameLogicalId

    • renameLogicalId(oldId: string, newId: string): void

    • Rename a generated logical identities

      To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

      -
      -
      -

      Parameters

      -
        -
      • -
        oldId: string
        • -
      • -
        newId: string
      -

      Returns void

      -
    -
    -

    getLogicalId

    -
      - -
    • -

      Allocates a stack-unique CloudFormation-compatible logical identity for a +

      Parameters

      • oldId: string
      • newId: string

      Returns void

    getLogicalId

    -
    -

    addDependency

    -
      - -
    • -

      Add a dependency between this stack and another stack.

      +

    Returns string

    addDependency

    • addDependency(target: Stack, reason?: string): void

    • Add a dependency between this stack and another stack.

      This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

      -
      -
      -

      Parameters

      -
        -
      • -
        target: Stack
        • -
      • -
        Optional reason: string
      -

      Returns void

      -
    -
    -

    formatArn

    -
      - -
    • -

      Creates an ARN from components.

      -

      If partition, region or account are not specified, the stack's +

      Parameters

      • target: Stack
      • Optionalreason: string

      Returns void

    formatArn

    • formatArn(components: ArnComponents): string

    • Creates an ARN from components.

      +

      If partition, region or account are not specified, the stack's partition, region and account will be used.

      If any component is the empty string, an empty string will be inserted into the generated ARN at the location that component corresponds to.

      The ARN will be formatted as follows:

      -

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      +

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      The required ARN pieces that are omitted will be taken from the stack that -the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope -can be 'undefined'.

      -
      -
      -

      Parameters

      -
        -
      • -
        components: ArnComponents
      -

      Returns string

      -
    -
    -

    splitArn

    -
      - -
    • -

      Splits the provided ARN into its components. -Works both if 'arn' is a string like 'arn:aws:s3:::bucket', +the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope +can be 'undefined'.

      +

      Parameters

      • components: ArnComponents

      Returns string

    splitArn

    • splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

    • Splits the provided ARN into its components. +Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

      -
      -
      -

      Parameters

      -
        -
      • -
        arn: string
        -

        the ARN to split into its components

        -
        -
        • -
      • -
        arnFormat: ArnFormat
        -

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        -
        -
      -

      Returns ArnComponents

      -
    -
    -

    addTransform

    -
      - -
    • -

      Add a Transform to this stack. A Transform is a macro that AWS +

      Parameters

      • arn: string

        the ARN to split into its components

        +
      • arnFormat: ArnFormat

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        +

      Returns ArnComponents

    addTransform

    -
    -

    addMetadata

    -
      - -
    • -

      Adds an arbitrary key-value pair, with information you want to record about the stack. +

    addMetadata

    -
    -

    _addAssemblyDependency

    -

    _addAssemblyDependency

    • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
    • Internal

      Called implicitly by the addDependency helper function in order to realize a dependency between two top-level stacks at the assembly level.

      Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

      -
      -
      -

      Parameters

      -
        -
      • -
        target: Stack
        • -
      • -
        Optional reason: StackDependencyReason
      -

      Returns void

      -
    -
    -

    _obtainAssemblyDependencies

    -
      -
    • _obtainAssemblyDependencies(reasonFilter): Element[]
      • -
    • Internal -

      Called implicitly by the obtainDependencies helper function in order to +

      Parameters

      • target: Stack
      • Optionalreason: StackDependencyReason

      Returns void

    _obtainAssemblyDependencies

    • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
    • Internal

      Called implicitly by the obtainDependencies helper function in order to collect resource dependencies across two top-level stacks at the assembly level.

      Use stack.obtainDependencies to see the dependencies between any two stacks.

      -
      -
      -

      Parameters

      -
        -
      • -
        reasonFilter: StackDependencyReason
      -

      Returns Element[]

      -
    -
    -

    _removeAssemblyDependency

    -
      -
    • _removeAssemblyDependency(target, reasonFilter?): void
      • -
    • Internal -

      Called implicitly by the removeDependency helper function in order to +

      Parameters

      • reasonFilter: StackDependencyReason

      Returns Element[]

    _removeAssemblyDependency

    • _removeAssemblyDependency(
          target: Stack,
          reasonFilter?: StackDependencyReason,
      ): void
    • Internal

      Called implicitly by the removeDependency helper function in order to remove a dependency between two top-level stacks at the assembly level.

      Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

      -
      -
      -

      Parameters

      -
        -
      • -
        target: Stack
        • -
      • -
        Optional reasonFilter: StackDependencyReason
      -

      Returns void

      -
    -
    -

    _synthesizeTemplate

    -
      -
    • _synthesizeTemplate(session, lookupRoleArn?, lookupRoleExternalId?, lookupRoleAdditionalOptions?): void
      • -
    • Internal -

      Synthesizes the cloudformation template into a cloud assembly.

      -
      -
      -

      Parameters

      -
        -
      • -
        session: ISynthesisSession
        • -
      • -
        Optional lookupRoleArn: string
        • -
      • -
        Optional lookupRoleExternalId: string
        • -
      • -
        Optional lookupRoleAdditionalOptions: {
            [key: string]: any;
        }
        -
          -
        • -
          [key: string]: any
      -

      Returns void

      -
    -
    -

    regionalFact

    -
      - -
    • -

      Look up a fact value for the given fact for the region of this stack

      +

      Parameters

      • target: Stack
      • OptionalreasonFilter: StackDependencyReason

      Returns void

    _synthesizeTemplate

    • _synthesizeTemplate(
          session: ISynthesisSession,
          lookupRoleArn?: string,
          lookupRoleExternalId?: string,
          lookupRoleAdditionalOptions?: { [key: string]: any },
      ): void
    • Internal

      Synthesizes the cloudformation template into a cloud assembly.

      +

      Parameters

      • session: ISynthesisSession
      • OptionallookupRoleArn: string
      • OptionallookupRoleExternalId: string
      • OptionallookupRoleAdditionalOptions: { [key: string]: any }

      Returns void

    regionalFact

    -
    -

    exportValue

    -
      - -
    • -

      Create a CloudFormation Export for a string value

      +

      Parameters

      • factName: string
      • OptionaldefaultValue: string

      Returns string

    exportValue

    Deployment 2: remove the bucket resource:

    • You are now free to remove the bucket resource from producerStack.
      • -
    • Don't forget to remove the exportValue() call as well.
      • +
    • Don't forget to remove the exportValue() call as well.
    • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
    -
    -
    -

    Parameters

    -
      -
    • -
      exportedValue: any
      • -
    • -
      Optional options: ExportValueOptions
    -

    Returns string

    -
    -
    -

    exportStringListValue

    -
      - -
    • -

      Create a CloudFormation Export for a string list value

      +

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string

    exportStringListValue

    • exportStringListValue(
          exportedValue: any,
          options?: ExportValueOptions,
      ): string[]

    • Create a CloudFormation Export for a string list value

      Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only export strings. You can control the name for the export by passing the name option.

      -

      If you don't supply a value for name, the value you're exporting must be +

      If you don't supply a value for name, the value you're exporting must be a Resource attribute (for example: bucket.bucketName) and it will be given the same name as the automatic cross-stack reference that would be created if you used the attribute in another Stack.

      @@ -1055,25 +268,7 @@

      exportStringListValue remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

      See exportValue for an example of this process.

      -

      -
      -

      Parameters

      -
        -
      • -
        exportedValue: any
        • -
      • -
        Optional options: ExportValueOptions
      -

      Returns string[]

      -
    -
    -

    Protected allocateLogicalId

    -
      - -
    • -

      Returns the naming scheme used to allocate logical IDs. By default, uses +

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string[]

    ProtectedallocateLogicalId

    • allocateLogicalId(cfnElement: CfnElement): string

    • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize this behavior.

      In order to make sure logical IDs are unique and stable, we hash the resource @@ -1081,15 +276,15 @@

      Protected

      The result will be:

      -

      <path.join('')><md5(path.join('/')> - "human" "hash"

      +

      <path.join('')><md5(path.join('/')> +"human" "hash"

      If the "human" part of the ID exceeds 240 characters, we simply trim it so -the total ID doesn't exceed CloudFormation's 255 character limit.

      +the total ID doesn't exceed CloudFormation's 255 character limit.

      We only take 8 characters from the md5 hash (0.000005 chance of collision).

      Special cases:

        -
      • If the path only contains a single component (i.e. it's a top-level -resource), we won't add the hash to it. The hash is not needed for +
      • If the path only contains a single component (i.e. it's a top-level +resource), we won't add the hash to it. The hash is not needed for disambiguation and also, it allows for a more straightforward migration an existing CloudFormation template to a CDK stack without logical ID changes (or renames).
        • @@ -1104,58 +299,13 @@

        Protected

      -

      -
      -

      Parameters

      -
        -
      • -
        cfnElement: CfnElement
        -

        The element for which the logical ID is allocated.

        -
        -
      -

      Returns string

      -
    -
    -

    Protected _validateId

    -
      -
    • _validateId(name): void
      • -
    • Internal -

      Validate stack name

      +

      Parameters

      • cfnElement: CfnElement

        The element for which the logical ID is allocated.

        +

      Returns string

    Protected_validateId

    • _validateId(name: string): void
    • Internal

      Validate stack name

      CloudFormation stack names can include dashes in addition to the regular identifier -character classes, and we don't allow one of the magic markers.

      -
      -
      -

      Parameters

      -
        -
      • -
        name: string
      -

      Returns void

      -
    -
    -

    Protected _toCloudFormation

    -
      -
    • _toCloudFormation(): any
      • -
    • Internal -

      Returns the CloudFormation template for this stack by traversing +character classes, and we don't allow one of the magic markers.

      +

      Parameters

      • name: string

      Returns void

    Protected_toCloudFormation

    • _toCloudFormation(): any
    • Internal

      Returns the CloudFormation template for this stack by traversing the tree and invoking _toCloudFormation() on all Entity objects.

      -
      -

      Returns any

      -
    -
    -

    Static isConstruct

    -
      - -
    • -

      Checks if x is a construct.

      +

      Returns any

    StaticisConstruct

    • isConstruct(x: any): x is Construct

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      Explanation: in JavaScript, multiple copies of the constructs library on @@ -1168,127 +318,7 @@

      Static instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

      -

      -
      -

      Parameters

      -
        -
      • -
        x: any
        -

        Any object

        -
        -
      -

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

      - -
    -
    -

    toString

    -
      - -
    • -

      Returns a string representation of this construct.

      -
      -

      Returns string

      -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -

    On This Page

     -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Parameters

    • x: any

      Any object

      +

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

    +

    toString

    • toString(): string

    • Returns a string representation of this construct.

      +

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/PipelineNetworkStack.html b/classes/PipelineNetworkStack.html index 3784882..3224dd5 100644 --- a/classes/PipelineNetworkStack.html +++ b/classes/PipelineNetworkStack.html @@ -1,156 +1,61 @@ -PipelineNetworkStack | aws4embeddedlinux-cdk-lib
    -
    - -
    -
    -
    -
    - -

    Class PipelineNetworkStack

    -
    -

    The network resources to run the pipeline in.

    +PipelineNetworkStack | aws4embeddedlinux-cdk-lib

    Class PipelineNetworkStack

    The network resources to run the pipeline in.

    This stack is provided for when users do not have an existing VPC with private and public subnets for the pipeline.

    -
    -
    -
    -

    Hierarchy

    -
      -
    • Stack -
        -
      • PipelineNetworkStack
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    constructor -
    -
    -

    Properties

    -
    vpc -tags -templateOptions -region -account -environment -nestedStackResource? -templateFile -artifactId -synthesizer -_versionReportingEnabled -_crossRegionReferences -_notificationArns? -node -
    -
    -

    Accessors

    -
    terminationProtection -permissionsBoundaryArn -dependencies -stackName -partition -urlSuffix -stackId -notificationArns -nested -availabilityZones -nestedStackParent -maxResources -bundlingRequired -
    -
    -

    Methods

    -
    isStack -of -resolve -toJsonString -toYamlString -reportMissingContextKey -renameLogicalId -getLogicalId -addDependency -formatArn -splitArn -addTransform -addMetadata -_addAssemblyDependency -_obtainAssemblyDependencies -_removeAssemblyDependency -_synthesizeTemplate -regionalFact -exportValue -exportStringListValue -allocateLogicalId -_validateId -_toCloudFormation -isConstruct -toString -
    -
    -

    Constructors

    -
    -

    constructor

    -
    -
    -

    Properties

    -
    -

    Readonly vpc

    -
    vpc: IVpc
    -

    The VPC for the pipeline to reside in.

    -
    -
    -
    -

    Readonly tags

    -
    tags: TagManager
    -

    Tags to be applied to the stack.

    -
    -
    -
    -

    Readonly templateOptions

    -
    templateOptions: ITemplateOptions
    -

    Options for CloudFormation template (like version, transform, description).

    -
    -
    -
    -

    Readonly region

    -
    region: string
    -

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    +

    Hierarchy

    • Stack
      • PipelineNetworkStack

    Constructors

    constructor +

    Properties

    vpc +tags +templateOptions +region +account +environment +nestedStackResource? +templateFile +artifactId +synthesizer +_versionReportingEnabled +_crossRegionReferences +_notificationArns? +node +

    Accessors

    terminationProtection +dependencies +stackName +partition +urlSuffix +stackId +notificationArns +nested +availabilityZones +nestedStackParent +bundlingRequired +

    Methods

    isStack +of +resolve +toJsonString +toYamlString +reportMissingContextKey +renameLogicalId +getLogicalId +addDependency +formatArn +splitArn +addTransform +addMetadata +_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate +regionalFact +exportValue +exportStringListValue +allocateLogicalId +_validateId +_toCloudFormation +isConstruct +toString +

    Constructors

    constructor

    Properties

    Readonlyvpc

    vpc: IVpc

    The VPC for the pipeline to reside in.

    +

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    +

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    1. The value provided to env.region when the stack is defined. This can @@ -167,15 +72,7 @@

      Readonlyregion-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

      -

    -
    -
    -

    Readonly account

    -
    account: string
    -

    The AWS account into which this stack will be deployed.

    +

    Readonlyaccount

    account: string

    The AWS account into which this stack will be deployed.

    This value is resolved according to the following rules:

    1. The value provided to env.account when the stack is defined. This can @@ -192,15 +89,7 @@

      Readonlyaccount-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

      -

    -
    -
    -

    Readonly environment

    -
    environment: string
    -

    The environment coordinates in which this stack is deployed. In the form +

    Readonlyenvironment

    environment: string

    The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

    You can use this value to determine if two stacks are targeting the same @@ -209,430 +98,63 @@

    ReadonlyAws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

    -

    -
    -
    -

    Optional Readonly nestedStackResource

    -
    nestedStackResource?: CfnResource
    -

    If this is a nested stack, this represents its AWS::CloudFormation::Stack +

    Optional ReadonlynestedStackResource

    nestedStackResource?: CfnResource

    If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

    -
    -
    -
    -

    Readonly templateFile

    -
    templateFile: string
    -

    The name of the CloudFormation template file emitted to the output +

    ReadonlytemplateFile

    templateFile: string

    The name of the CloudFormation template file emitted to the output directory during synthesis.

    Example value: MyStack.template.json

    -
    -
    -
    -

    Readonly artifactId

    -
    artifactId: string
    -

    The ID of the cloud assembly artifact for this stack.

    -
    -
    -
    -

    Readonly synthesizer

    -
    synthesizer: IStackSynthesizer
    -

    Synthesis method for this stack

    -
    -
    -
    -

    Readonly Internal _versionReportingEnabled

    -
    _versionReportingEnabled: boolean
    -

    Whether version reporting is enabled for this stack

    +

    ReadonlyartifactId

    artifactId: string

    The ID of the cloud assembly artifact for this stack.

    +

    Readonlysynthesizer

    synthesizer: IStackSynthesizer

    Synthesis method for this stack

    +

    Readonly Internal_versionReportingEnabled

    _versionReportingEnabled: boolean

    Whether version reporting is enabled for this stack

    Controls whether the CDK Metadata resource is injected

    -
    -
    -
    -

    Readonly Internal _crossRegionReferences

    -
    _crossRegionReferences: boolean
    -

    Whether cross region references are enabled for this stack

    -
    -
    -
    -

    Optional Readonly Internal _notificationArns

    -
    _notificationArns?: string[]
    -

    SNS Notification ARNs to receive stack events.

    -
    -
    -
    -

    Readonly node

    -
    node: Node
    -

    The tree node.

    -
    -
    -
    -

    Accessors

    -
    -

    terminationProtection

    -
      -
    • get terminationProtection(): boolean
      • -
    • -

      Whether termination protection is enabled for this stack.

      -
      -

      Returns boolean

      -
      • -
    • set terminationProtection(value): void
      • -
    • -
      -

      Parameters

      -
        -
      • -
        value: boolean
      -

      Returns void

    -
    -

    Private permissionsBoundaryArn

    -
      -
    • get permissionsBoundaryArn(): any
      • -
    • -

      If a permissions boundary has been applied on this scope or any parent scope -then this will return the ARN of the permissions boundary.

      -

      This will return the permissions boundary that has been applied to the most -specific scope.

      -

      For example:

      -

      const stage = new Stage(app, 'stage', { - permissionsBoundary: PermissionsBoundary.fromName('stage-pb'), -});

      -

      const stack = new Stack(stage, 'Stack', { - permissionsBoundary: PermissionsBoundary.fromName('some-other-pb'), -});

      -

      Stack.permissionsBoundaryArn === 'arn:${AWS::Partition}:iam::${AWS::AccountId}:policy/some-other-pb';

      -
      -

      Returns any

      the name of the permissions boundary or undefined if not set

      - -
    -
    -

    dependencies

    -
      -
    • get dependencies(): Stack[]
      • -
    • -

      Return the stacks this stack depends on

      -
      -

      Returns Stack[]

      -
    -
    -

    stackName

    -
      -
    • get stackName(): string
      • -
    • -

      The concrete CloudFormation physical stack name.

      +

    Readonly Internal_crossRegionReferences

    _crossRegionReferences: boolean

    Whether cross region references are enabled for this stack

    +

    Optional Readonly Internal_notificationArns

    _notificationArns?: string[]

    SNS Notification ARNs to receive stack events.

    +

    Readonlynode

    node: Node

    The tree node.

    +

    Accessors

    terminationProtection

    • get terminationProtection(): boolean

    • Whether termination protection is enabled for this stack.

      +

      Returns boolean

    • set terminationProtection(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    dependencies

    • get dependencies(): Stack[]

    • Return the stacks this stack depends on

      +

      Returns Stack[]

    stackName

    • get stackName(): string

    • The concrete CloudFormation physical stack name.

      This is either the name defined explicitly in the stackName prop or -allocated based on the stack's location in the construct tree. Stacks that +allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack name. Stacks that are defined deeper within the tree will use a hashed naming scheme based on the construct path to ensure uniqueness.

      If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.

      -
      -

      Returns string

      -
    -
    -

    partition

    -
      -
    • get partition(): string
      • -
    • -

      The partition in which this stack is defined

      -
      -

      Returns string

      -
    -
    -

    urlSuffix

    -
      -
    • get urlSuffix(): string
      • -
    • -

      The Amazon domain suffix for the region in which this stack is defined

      -
      -

      Returns string

      -
    -
    -

    stackId

    -
      -
    • get stackId(): string
      • -
    • -

      The ID of the stack

      -
      -

      Returns string

      -
      -

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
-
      -
    -
    -

    notificationArns

    -
      -
    • get notificationArns(): string[]
      • -
    • -

      Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      -
      -

      Returns string[]

      -
    -
    -

    nested

    -
      -
    • get nested(): boolean
      • -
    • -

      Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      -
      -

      Returns boolean

      -
    -
    -

    availabilityZones

    -
      -
    • get availabilityZones(): string[]
      • -
    • -

      Returns the list of AZs that are available in the AWS environment +

      Returns string

    partition

    • get partition(): string

    • The partition in which this stack is defined

      +

      Returns string

    urlSuffix

    • get urlSuffix(): string

    • The Amazon domain suffix for the region in which this stack is defined

      +

      Returns string

    stackId

    • get stackId(): string

    • The ID of the stack

      +

      Returns string

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+
      + +

    notificationArns

    • get notificationArns(): string[]

    • Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      +

      Returns string[]

    nested

    • get nested(): boolean

    • Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      +

      Returns boolean

    availabilityZones

    • get availabilityZones(): string[]

    • Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

      If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve -at deploy-time to the first two availability zones returned from CloudFormation's +at deploy-time to the first two availability zones returned from CloudFormation's Fn::GetAZs intrinsic function.

      If they are not available in the context, returns a set of dummy values and reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

      To specify a different strategy for selecting availability zones override this method.

      -
      -

      Returns string[]

      -
    -
    -

    nestedStackParent

    -
      -
    • get nestedStackParent(): undefined | Stack
      • -
    • -

      If this is a nested stack, returns it's parent stack.

      -
      -

      Returns undefined | Stack

      -
    -
    -

    Private maxResources

    -
      -
    • get maxResources(): any
      • -
    • -

      Maximum number of resources in the stack

      -

      Set to 0 to mean "unlimited".

      -
      -

      Returns any

      -
    -
    -

    bundlingRequired

    -
      -
    • get bundlingRequired(): boolean
      • -
    • -

      Indicates whether the stack requires bundling or not

      -
      -

      Returns boolean

      -
    -
    -

    Methods

    -
    -

    Static isStack

    -
      - -
    • -

      Return whether the given object is a Stack.

      -

      We do attribute detection since we can't reliably use 'instanceof'.

      -
      -
      -

      Parameters

      -
        -
      • -
        x: any
      -

      Returns x is Stack

      -
    -
    -

    Static of

    -
      - -
    • -

      Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      -
      -
      -

      Parameters

      -
        -
      • -
        construct: IConstruct
        -

        The construct to start the search from.

        -
        -
      -

      Returns Stack

      -
    -
    -

    resolve

    -
      - -
    • -

      Resolve a tokenized value in the context of the current stack.

      -
      -
      -

      Parameters

      -
        -
      • -
        obj: any
      -

      Returns any

      -
    -
    -

    toJsonString

    -
      - -
    • -

      Convert an object, potentially containing tokens, to a JSON string

      -
      -
      -

      Parameters

      -
        -
      • -
        obj: any
        • -
      • -
        Optional space: number
      -

      Returns string

      -
    -
    -

    toYamlString

    -
      - -
    • -

      Convert an object, potentially containing tokens, to a YAML string

      -
      -
      -

      Parameters

      -
        -
      • -
        obj: any
      -

      Returns string

      -
    -
    -

    reportMissingContextKey

    -
      - -
    • -

      Indicate that a context key was expected

      +

      Returns string[]

    nestedStackParent

    • get nestedStackParent(): undefined | Stack

    • If this is a nested stack, returns it's parent stack.

      +

      Returns undefined | Stack

    bundlingRequired

    • get bundlingRequired(): boolean

    • Indicates whether the stack requires bundling or not

      +

      Returns boolean

    Methods

    StaticisStack

    • isStack(x: any): x is Stack

    • Return whether the given object is a Stack.

      +

      We do attribute detection since we can't reliably use 'instanceof'.

      +

      Parameters

      • x: any

      Returns x is Stack

    Staticof

    • of(construct: IConstruct): Stack

    • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      +

      Parameters

      • construct: IConstruct

        The construct to start the search from.

        +

      Returns Stack

    resolve

    • resolve(obj: any): any

    • Resolve a tokenized value in the context of the current stack.

      +

      Parameters

      • obj: any

      Returns any

    toJsonString

    • toJsonString(obj: any, space?: number): string

    • Convert an object, potentially containing tokens, to a JSON string

      +

      Parameters

      • obj: any
      • Optionalspace: number

      Returns string

    toYamlString

    • toYamlString(obj: any): string

    • Convert an object, potentially containing tokens, to a YAML string

      +

      Parameters

      • obj: any

      Returns string

    reportMissingContextKey

    • reportMissingContextKey(report: MissingContext): void

    • Indicate that a context key was expected

      Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

      -
      -
      -

      Parameters

      -
        -
      • -
        report: MissingContext
        -

        The set of parameters needed to obtain the context

        -
        -
      -

      Returns void

      -
    -
    -

    renameLogicalId

    -
      - -
    • -

      Rename a generated logical identities

      +

      Parameters

      • report: MissingContext

        The set of parameters needed to obtain the context

        +

      Returns void

    renameLogicalId

    • renameLogicalId(oldId: string, newId: string): void

    • Rename a generated logical identities

      To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

      -
      -
      -

      Parameters

      -
        -
      • -
        oldId: string
        • -
      • -
        newId: string
      -

      Returns void

      -
    -
    -

    getLogicalId

    -
      - -
    • -

      Allocates a stack-unique CloudFormation-compatible logical identity for a +

      Parameters

      • oldId: string
      • newId: string

      Returns void

    getLogicalId

    -
    -

    addDependency

    -
      - -
    • -

      Add a dependency between this stack and another stack.

      +

    Returns string

    addDependency

    • addDependency(target: Stack, reason?: string): void

    • Add a dependency between this stack and another stack.

      This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

      -
      -
      -

      Parameters

      -
        -
      • -
        target: Stack
        • -
      • -
        Optional reason: string
      -

      Returns void

      -
    -
    -

    formatArn

    -
      - -
    • -

      Creates an ARN from components.

      -

      If partition, region or account are not specified, the stack's +

      Parameters

      • target: Stack
      • Optionalreason: string

      Returns void

    formatArn

    • formatArn(components: ArnComponents): string

    • Creates an ARN from components.

      +

      If partition, region or account are not specified, the stack's partition, region and account will be used.

      If any component is the empty string, an empty string will be inserted into the generated ARN at the location that component corresponds to.

      The ARN will be formatted as follows:

      -

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      +

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      The required ARN pieces that are omitted will be taken from the stack that -the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope -can be 'undefined'.

      -
      -
      -

      Parameters

      -
        -
      • -
        components: ArnComponents
      -

      Returns string

      -
    -
    -

    splitArn

    -
      - -
    • -

      Splits the provided ARN into its components. -Works both if 'arn' is a string like 'arn:aws:s3:::bucket', +the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope +can be 'undefined'.

      +

      Parameters

      • components: ArnComponents

      Returns string

    splitArn

    • splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

    • Splits the provided ARN into its components. +Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

      -
      -
      -

      Parameters

      -
        -
      • -
        arn: string
        -

        the ARN to split into its components

        -
        -
        • -
      • -
        arnFormat: ArnFormat
        -

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        -
        -
      -

      Returns ArnComponents

      -
    -
    -

    addTransform

    -
      - -
    • -

      Add a Transform to this stack. A Transform is a macro that AWS +

      Parameters

      • arn: string

        the ARN to split into its components

        +
      • arnFormat: ArnFormat

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        +

      Returns ArnComponents

    addTransform

    -
    -

    addMetadata

    -
      - -
    • -

      Adds an arbitrary key-value pair, with information you want to record about the stack. +

    addMetadata

    -
    -

    _addAssemblyDependency

    -

    _addAssemblyDependency

    • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
    • Internal

      Called implicitly by the addDependency helper function in order to realize a dependency between two top-level stacks at the assembly level.

      Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

      -
      -
      -

      Parameters

      -
        -
      • -
        target: Stack
        • -
      • -
        Optional reason: StackDependencyReason
      -

      Returns void

      -
    -
    -

    _obtainAssemblyDependencies

    -
      -
    • _obtainAssemblyDependencies(reasonFilter): Element[]
      • -
    • Internal -

      Called implicitly by the obtainDependencies helper function in order to +

      Parameters

      • target: Stack
      • Optionalreason: StackDependencyReason

      Returns void

    _obtainAssemblyDependencies

    • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
    • Internal

      Called implicitly by the obtainDependencies helper function in order to collect resource dependencies across two top-level stacks at the assembly level.

      Use stack.obtainDependencies to see the dependencies between any two stacks.

      -
      -
      -

      Parameters

      -
        -
      • -
        reasonFilter: StackDependencyReason
      -

      Returns Element[]

      -
    -
    -

    _removeAssemblyDependency

    -
      -
    • _removeAssemblyDependency(target, reasonFilter?): void
      • -
    • Internal -

      Called implicitly by the removeDependency helper function in order to +

      Parameters

      • reasonFilter: StackDependencyReason

      Returns Element[]

    _removeAssemblyDependency

    • _removeAssemblyDependency(
          target: Stack,
          reasonFilter?: StackDependencyReason,
      ): void
    • Internal

      Called implicitly by the removeDependency helper function in order to remove a dependency between two top-level stacks at the assembly level.

      Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

      -
      -
      -

      Parameters

      -
        -
      • -
        target: Stack
        • -
      • -
        Optional reasonFilter: StackDependencyReason
      -

      Returns void

      -
    -
    -

    _synthesizeTemplate

    -
      -
    • _synthesizeTemplate(session, lookupRoleArn?, lookupRoleExternalId?, lookupRoleAdditionalOptions?): void
      • -
    • Internal -

      Synthesizes the cloudformation template into a cloud assembly.

      -
      -
      -

      Parameters

      -
        -
      • -
        session: ISynthesisSession
        • -
      • -
        Optional lookupRoleArn: string
        • -
      • -
        Optional lookupRoleExternalId: string
        • -
      • -
        Optional lookupRoleAdditionalOptions: {
            [key: string]: any;
        }
        -
          -
        • -
          [key: string]: any
      -

      Returns void

      -
    -
    -

    regionalFact

    -
      - -
    • -

      Look up a fact value for the given fact for the region of this stack

      +

      Parameters

      • target: Stack
      • OptionalreasonFilter: StackDependencyReason

      Returns void

    _synthesizeTemplate

    • _synthesizeTemplate(
          session: ISynthesisSession,
          lookupRoleArn?: string,
          lookupRoleExternalId?: string,
          lookupRoleAdditionalOptions?: { [key: string]: any },
      ): void
    • Internal

      Synthesizes the cloudformation template into a cloud assembly.

      +

      Parameters

      • session: ISynthesisSession
      • OptionallookupRoleArn: string
      • OptionallookupRoleExternalId: string
      • OptionallookupRoleAdditionalOptions: { [key: string]: any }

      Returns void

    regionalFact

    -
    -

    exportValue

    -
      - -
    • -

      Create a CloudFormation Export for a string value

      +

      Parameters

      • factName: string
      • OptionaldefaultValue: string

      Returns string

    exportValue

    Deployment 2: remove the bucket resource:

    • You are now free to remove the bucket resource from producerStack.
      • -
    • Don't forget to remove the exportValue() call as well.
      • +
    • Don't forget to remove the exportValue() call as well.
    • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
    -
    -
    -

    Parameters

    -
      -
    • -
      exportedValue: any
      • -
    • -
      Optional options: ExportValueOptions
    -

    Returns string

    -
    -
    -

    exportStringListValue

    -
      - -
    • -

      Create a CloudFormation Export for a string list value

      +

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string

    exportStringListValue

    • exportStringListValue(
          exportedValue: any,
          options?: ExportValueOptions,
      ): string[]

    • Create a CloudFormation Export for a string list value

      Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only export strings. You can control the name for the export by passing the name option.

      -

      If you don't supply a value for name, the value you're exporting must be +

      If you don't supply a value for name, the value you're exporting must be a Resource attribute (for example: bucket.bucketName) and it will be given the same name as the automatic cross-stack reference that would be created if you used the attribute in another Stack.

      @@ -974,25 +271,7 @@

      exportStringListValue remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

      See exportValue for an example of this process.

      -

      -
      -

      Parameters

      -
        -
      • -
        exportedValue: any
        • -
      • -
        Optional options: ExportValueOptions
      -

      Returns string[]

      -
    -
    -

    Protected allocateLogicalId

    -
      - -
    • -

      Returns the naming scheme used to allocate logical IDs. By default, uses +

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string[]

    ProtectedallocateLogicalId

    • allocateLogicalId(cfnElement: CfnElement): string

    • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize this behavior.

      In order to make sure logical IDs are unique and stable, we hash the resource @@ -1000,15 +279,15 @@

      Protected

      The result will be:

      -

      <path.join('')><md5(path.join('/')> - "human" "hash"

      +

      <path.join('')><md5(path.join('/')> +"human" "hash"

      If the "human" part of the ID exceeds 240 characters, we simply trim it so -the total ID doesn't exceed CloudFormation's 255 character limit.

      +the total ID doesn't exceed CloudFormation's 255 character limit.

      We only take 8 characters from the md5 hash (0.000005 chance of collision).

      Special cases:

        -
      • If the path only contains a single component (i.e. it's a top-level -resource), we won't add the hash to it. The hash is not needed for +
      • If the path only contains a single component (i.e. it's a top-level +resource), we won't add the hash to it. The hash is not needed for disambiguation and also, it allows for a more straightforward migration an existing CloudFormation template to a CDK stack without logical ID changes (or renames).
        • @@ -1023,58 +302,13 @@

        Protected

      -

      -
      -

      Parameters

      -
        -
      • -
        cfnElement: CfnElement
        -

        The element for which the logical ID is allocated.

        -
        -
      -

      Returns string

      -
    -
    -

    Protected _validateId

    -
      -
    • _validateId(name): void
      • -
    • Internal -

      Validate stack name

      +

      Parameters

      • cfnElement: CfnElement

        The element for which the logical ID is allocated.

        +

      Returns string

    Protected_validateId

    • _validateId(name: string): void
    • Internal

      Validate stack name

      CloudFormation stack names can include dashes in addition to the regular identifier -character classes, and we don't allow one of the magic markers.

      -
      -
      -

      Parameters

      -
        -
      • -
        name: string
      -

      Returns void

      -
    -
    -

    Protected _toCloudFormation

    -
      -
    • _toCloudFormation(): any
      • -
    • Internal -

      Returns the CloudFormation template for this stack by traversing +character classes, and we don't allow one of the magic markers.

      +

      Parameters

      • name: string

      Returns void

    Protected_toCloudFormation

    • _toCloudFormation(): any
    • Internal

      Returns the CloudFormation template for this stack by traversing the tree and invoking _toCloudFormation() on all Entity objects.

      -
      -

      Returns any

      -
    -
    -

    Static isConstruct

    -
      - -
    • -

      Checks if x is a construct.

      +

      Returns any

    StaticisConstruct

    • isConstruct(x: any): x is Construct

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      Explanation: in JavaScript, multiple copies of the constructs library on @@ -1087,122 +321,7 @@

      Static instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

      -

      -
      -

      Parameters

      -
        -
      • -
        x: any
        -

        Any object

        -
        -
      -

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

      - -
    -
    -

    toString

    -
      - -
    • -

      Returns a string representation of this construct.

      -
      -

      Returns string

      -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -

    On This Page

     -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Parameters

    • x: any

      Any object

      +

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

    +

    toString

    • toString(): string

    • Returns a string representation of this construct.

      +

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html index 62e48ec..9c61233 100644 --- a/classes/SourceRepo.html +++ b/classes/SourceRepo.html @@ -1,100 +1,14 @@ -SourceRepo | aws4embeddedlinux-cdk-lib
    -
    - -
    -
    -
    -
    - -

    Class SourceRepo

    -
    -

    The repository for the Source Stage of the pipeline.

    +SourceRepo | aws4embeddedlinux-cdk-lib

    Class SourceRepo

    The repository for the Source Stage of the pipeline.

    The initial contents of this repository are seeded by the assets contained in the source-repo/ folder of this library.

    -
    -
    -
    -

    Hierarchy

    -
      -
    • Construct -
        -
      • SourceRepo
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    constructor -
    -
    -

    Properties

    -
    repo -node -
    -
    -

    Methods

    -
    isConstruct -toString -
    -
    -

    Constructors

    -
    -

    constructor

    -
    -
    -

    Properties

    -
    -

    Readonly repo

    -
    repo: Repository
    -

    The CodeCommit Repo itself.

    -
    -
    -
    -

    Readonly node

    -
    node: Node
    -

    The tree node.

    -
    -
    -
    -

    Methods

    -
    -

    Static isConstruct

    -
      - -
    • -

      Checks if x is a construct.

      +

    Hierarchy

    • Construct
      • SourceRepo

    Constructors

    constructor +

    Properties

    repo +node +

    Methods

    isConstruct +toString +

    Constructors

    constructor

    Properties

    Readonlyrepo

    repo: Repository

    The CodeCommit Repo itself.

    +

    Readonlynode

    node: Node

    The tree node.

    +

    Methods

    StaticisConstruct

    • isConstruct(x: any): x is Construct

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      Explanation: in JavaScript, multiple copies of the constructs library on @@ -107,74 +21,7 @@

      Static instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

      -

      -
      -

      Parameters

      -
        -
      • -
        x: any
        -

        Any object

        -
        -
      -

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

      - -
    -
    -

    toString

    -
      - -
    • -

      Returns a string representation of this construct.

      -
      -

      Returns string

      -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -

    On This Page

     -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Parameters

    • x: any

      Any object

      +

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

    +

    toString

    • toString(): string

    • Returns a string representation of this construct.

      +

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/enums/ImageKind.html b/enums/ImageKind.html index 2d04769..f29c626 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -1,82 +1,4 @@ -ImageKind | aws4embeddedlinux-cdk-lib
    -
    - -
    -
    -
    -
    - -

    Enumeration ImageKind

    -
    -

    The type of Image to build on.

    -
    -
    -
    -
    -
    - -
    -
    -

    Enumeration Members

    -
    Ubuntu22_04 -
    -
    -

    Enumeration Members

    -
    -

    Ubuntu22_04

    -
    Ubuntu22_04: "ubuntu_22_04"
    -

    Ubuntu 22.04 (LTS)

    -
    -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -

    On This Page

     -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +ImageKind | aws4embeddedlinux-cdk-lib

    Enumeration ImageKind

    The type of Image to build on.

    +

    Enumeration Members

    Ubuntu22_04 +

    Enumeration Members

    Ubuntu22_04

    Ubuntu22_04: "ubuntu_22_04"

    Ubuntu 22.04 (LTS)

    +

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html index 7254af3..2dfdb6a 100644 --- a/enums/ProjectKind.html +++ b/enums/ProjectKind.html @@ -1,142 +1,16 @@ -ProjectKind | aws4embeddedlinux-cdk-lib
    -
    - -
    -
    -
    -
    - -

    Enumeration ProjectKind

    -
    -

    The kind of project built.

    -
    -
    -
    -
    -
    - -
    -
    -

    Enumeration Members

    -
    Poky -MetaAwsDemo -PokyAmi -Kas -Renesas -NxpImx -CodeBuild -
    -
    -

    Enumeration Members

    -
    -

    Poky

    -
    Poky: "poky"
    -

    Build core-image-minimal from poky.

    -
    -
    -
    -

    MetaAwsDemo

    -
    MetaAwsDemo: "meta-aws-demo"
    -

    Build the Qemu meta-aws Demonstration Distribution.

    -
    -
    -
    -

    PokyAmi

    -
    PokyAmi: "poky-ami"
    -

    Build an EC2 AMI

    -
    -
    -
    -

    Kas

    -
    Kas: "kas"
    -

    Build an kas based image

    -
    -
    -
    -

    Renesas

    -
    Renesas: "renesas"
    -

    Build an Renesas image

    -
    -
    -
    -

    NxpImx

    -
    NxpImx: "nxp-imx"
    -

    Build an IMX image using NXP layers.

    -
    -
    -
    -

    CodeBuild

    -
    CodeBuild: "codebuild"
    -

    Build no pipeline, just CodeBuild project to connect with GitHub actions.

    -
    -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -

    On This Page

     -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +ProjectKind | aws4embeddedlinux-cdk-lib

    Enumeration ProjectKind

    The kind of project built.

    +

    Enumeration Members

    Poky +MetaAwsDemo +PokyAmi +Kas +Renesas +NxpImx +CodeBuild +

    Enumeration Members

    Poky

    Poky: "poky"

    Build core-image-minimal from poky.

    +

    MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"

    Build the Qemu meta-aws Demonstration Distribution.

    +

    PokyAmi

    PokyAmi: "poky-ami"

    Build an EC2 AMI

    +

    Kas

    Kas: "kas"

    Build an kas based image

    +

    Renesas

    Renesas: "renesas"

    Build an Renesas image

    +

    NxpImx

    NxpImx: "nxp-imx"

    Build an IMX image using NXP layers.

    +

    CodeBuild

    CodeBuild: "codebuild"

    Build no pipeline, just CodeBuild project to connect with GitHub actions.

    +

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/index.html b/index.html index 22483e2..47ef0f2 100644 --- a/index.html +++ b/index.html @@ -1,139 +1,64 @@ -aws4embeddedlinux-cdk-lib
    -
    - -
    -
    -
    -
    -

    aws4embeddedlinux-cdk-lib

    -

    aws4embeddedlinux-ci

    This cdk IaC library helps you to deploy AWS cloud infrastructure to allow embedded Linux builds for your project.

    -

    Architecture

    architecture overview

    -

    API documentation

    API documentation generated by npm run doc

    -

    Setting Up

    In order to use this library, you must set up the CDK, including -installing the CDK tool and bootstrapping the account you wish to deploy to. Additionally, you must have Node installed.

    -
    -

    [!NOTE] +aws4embeddedlinux-cdk-lib

    aws4embeddedlinux-cdk-lib

    aws4embeddedlinux-ci

    This cdk IaC library helps you to deploy AWS cloud infrastructure to allow embedded Linux builds for your project.

    +

    Architecture

    architecture overview

    +

    API documentation

    API documentation generated by npm run doc

    +

    Setting Up

    In order to use this library, you must set up the CDK, including +installing the CDK tool and bootstrapping the account you wish to deploy to. Additionally, you must have Node installed.

    +
    Note

    This library is tested against Node Versions 16, 18, and 20. If these versions are not available for your system, we recommend -using NVM to install a compatible version

    -
    -

    Quickstart

    Use the examples in our examples repo.

    -

    Setting Up A New Project

      -
    1. Create a CDK project. More details can be found in the CDK Getting Started Documentation.
      mkdir my-project
      cd my-project
      cdk init app --language typescript
+using NVM to install a compatible version
      
+
    +

    Quickstart

    Use the examples in our examples repo.

    +

    Setting Up A New Project

      +
    1. Create a CDK project. More details can be found in the CDK Getting Started Documentation.
      mkdir my-project
      cd my-project
      cdk init app --language typescript
      +
    2. Add the cdk library with npm install aws4embeddedlinux/aws4embeddedlinux-ci.
      3. -
    3. Create your application using the library. Refer to the API Documentation +
    4. Create your application using the library. Refer to the API Documentation and the Examples for more details.
    5. Deploy your application using cdk deploy.
      6. -
    6. After the application is deployed, the 'Build Image' Pipeline needs to be run. This will create an Ubuntu based container for +
    7. After the application is deployed, the 'Build Image' Pipeline needs to be run. This will create an Ubuntu based container for building Yocto. This container is used by the other pipelines. If the other pipelines are run before this container is created -and pushed to ECR, they will fail. This Build Image Pipeline will run weekly by default to keep +and pushed to ECR, they will fail. This Build Image Pipeline will run weekly by default to keep this container patched.
    8. Now the application pipeline can be run. This will push the contents of the Yocto deploy directory into S3.
    -

    Viewing Changes

    The cdk diff command can be used to preview changes before deployment. This will allow the user to review what is being created.

    -

    Development Setup

    You can use npm link to develop with a local copy of this repo.

    -

    In this library repo:

    npm install
-
    -

    In your-project folder:

    npm install
    npm link ../aws4embeddedlinux-ci
-
    +

    Viewing Changes

    The cdk diff command can be used to preview changes before deployment. This will allow the user to review what is being created.

    +

    Development Setup

    You can use npm link to develop with a local copy of this repo.

    +

    In this library repo:

    npm install
+
    + +

    In your-project folder:

    npm install
    npm link ../aws4embeddedlinux-ci
+
    +

    This will link through the system node_modules install. When using a system node install on Linux, this can require sudo access. To avoid this, use -a node version manager -or set a node prefix.

    -

    Known issues

      +a node version manager +or set a node prefix.

      +

      Known issues

      • Windows is currently not supported.
      • When using AWS Cloud9 a micro instance type will run out of memory.
      • Deletion of stacks while a CodePipeline is running can lead to unexpected failures.
      -

      Security

      See SECURITY for more information about reporting issues with this project.

      -

      Git Credentials and Build Time Secrets

      AWS Secrets Manager is the preferred method of adding secrets +

      Security

      See SECURITY for more information about reporting issues with this project.

      +

      Git Credentials and Build Time Secrets

      AWS Secrets Manager is the preferred method of adding secrets to your pipeline. This service provides a structured means of access and avoids the pitfalls of putting secrets in environment variables, source repos, etc.

      1. Create a Secret in Secrets Manager and add your secret value.
      2. Grant access permissions to the CodeBuild pipeline project.
        3. -
      3. Create a Policy Statement which allows secretsmanager:GetSecretValue for your secret.
        4. +
      4. Create a Policy Statement which allows secretsmanager:GetSecretValue for your secret.
      5. Add this policy statement to the buildPolicyAdditions props for the EmbeddedLinuxPipelineStack. e.g.
      -
      import * as iam from "aws-cdk-lib/aws-iam";


      const pipeline = new EmbeddedLinuxPipelineStack(app, "MyPokyPipeline", {
        imageRepo: buildImageRepo.repository,
        imageTag: ImageKind.Ubuntu22_04,
        vpc: vpc.vpc,
        buildPolicyAdditions: [
          iam.PolicyStatement.fromJson({
            Effect: "Allow",
            Action: "secretsmanager:GetSecretValue",
            Resource:
              "arn:aws:secretsmanager:us-west-2:123456789012:secret:my-secret-??????",
          }),
        ],
      });
-
      +
      import * as iam from "aws-cdk-lib/aws-iam";

      const pipeline = new EmbeddedLinuxPipelineStack(app, "MyPokyPipeline", {
        imageRepo: buildImageRepo.repository,
        imageTag: ImageKind.Ubuntu22_04,
        vpc: vpc.vpc,
        buildPolicyAdditions: [
          iam.PolicyStatement.fromJson({
            Effect: "Allow",
            Action: "secretsmanager:GetSecretValue",
            Resource:
              "arn:aws:secretsmanager:us-west-2:123456789012:secret:my-secret-??????",
          }),
        ],
      });
+
      +

      The secret can then be used in the CodeBuild Project by adding it to the BuildSpec. See -the CodeBuild Documentation for more details.

      -
      env:
          secrets-manager:
              SECRET_VALUE: "<Secret ARN>"
-
      -

      CVE Checking With Yocto

      CVE checking is enabled in the reference implementations. Details on this can be found in -the yocto documentation.

      -

      Contributing

      See CONTRIBUTING for more information.

      -

      License

      This library is licensed under the MIT-0 License. See the LICENSE file.

      -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -

    On This Page

     -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +the CodeBuild Documentation for more details.

    +
    env:
        secrets-manager:
            SECRET_VALUE: "<Secret ARN>"
+
    + +

    CVE Checking With Yocto

    CVE checking is enabled in the reference implementations. Details on this can be found in +the yocto documentation.

    +

    Contributing

    See CONTRIBUTING for more information.

    +

    License

    This library is licensed under the MIT-0 License. See the LICENSE file.

    +

    Settings

    Member Visibility

    On This Page

    aws4embeddedlinux-ciSetting Up
    diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html index e251ad2..7845234 100644 --- a/interfaces/BuildImageDataProps.html +++ b/interfaces/BuildImageDataProps.html @@ -1,78 +1,22 @@ -BuildImageDataProps | aws4embeddedlinux-cdk-lib
    -
    - -
    -
    -
    -
    - -

    Interface BuildImageDataProps

    -
    -

    Select options for the BuildImageDataStack.

    -
    -
    -
    -

    Hierarchy

    -
      -
    • StackProps -
        -
      • BuildImageDataProps
    -
    -
    -
    - -
    -
    -

    Properties

    -
    bucketName -description? -env? -stackName? -tags? -notificationArns? -synthesizer? -terminationProtection? -analyticsReporting? -crossRegionReferences? -permissionsBoundary? -suppressTemplateIndentation? -
    -
    -

    Properties

    -
    -

    Readonly bucketName

    -
    bucketName: string
    -

    The bucket name for image build sources. This must be globally unique.

    -
    -
    -
    -

    Optional Readonly description

    -
    description?: string
    -

    A description of the stack.

    -
    -
    -

    Default

    - No description.
-
    -
    -
    -

    Optional Readonly env

    -
    env?: Environment
    -

    The AWS environment (account/region) where this stack will be deployed.

    +BuildImageDataProps | aws4embeddedlinux-cdk-lib

    Interface BuildImageDataProps

    Select options for the BuildImageDataStack.

    +
    interface BuildImageDataProps {
        bucketName: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • BuildImageDataProps

    Properties

    bucketName +description? +env? +stackName? +tags? +notificationArns? +synthesizer? +terminationProtection? +analyticsReporting? +crossRegionReferences? +permissionsBoundary? +suppressTemplateIndentation? +

    Properties

    ReadonlybucketName

    bucketName: string

    The bucket name for image build sources. This must be globally unique.

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Default

    - No description.
+
    + +

    Optional Readonlyenv

    env?: Environment

    The AWS environment (account/region) where this stack will be deployed.

    Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables @@ -88,65 +32,27 @@

    Optionalec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the -environment's AWS partition, and other such enhancements.

    -

    -
    -

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
-
    +environment's AWS partition, and other such enhancements.

    +

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
+
    -

    Default

      +

    Default

    • The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
    -
    -
    -

    Optional Readonly stackName

    -
    stackName?: string
    -

    Name to deploy the stack with

    -
    -
    -

    Default

    - Derived from construct path.
-
    -
    -
    -

    Optional Readonly tags

    -
    tags?: {
        [key: string]: string;
    }
    -

    Stack tags that will be applied to all the taggable resources and the stack itself.

    -
    -
    -

    Type declaration

    -
      -
    • -
      [key: string]: string
    -
    -

    Default

    {}
-
    -
    -
    -

    Optional Readonly notificationArns

    -
    notificationArns?: string[]
    -

    SNS Topic ARNs that will receive stack events.

    -
    -
    -

    Default

    - no notfication arns.
-
    -
    -
    -

    Optional Readonly synthesizer

    -
    synthesizer?: IStackSynthesizer
    -

    Synthesis method to use while deploying this stack

    +

    Optional ReadonlystackName

    stackName?: string

    Name to deploy the stack with

    +

    Default

    - Derived from construct path.
+
    + +

    Optional Readonlytags

    tags?: { [key: string]: string }

    Stack tags that will be applied to all the taggable resources and the stack itself.

    +

    Default

    {}
+
    + +

    Optional ReadonlynotificationArns

    notificationArns?: string[]

    SNS Topic ARNs that will receive stack events.

    +

    Default

    - no notfication arns.
+
    + +

    Optional Readonlysynthesizer

    synthesizer?: IStackSynthesizer

    Synthesis method to use while deploying this stack

    The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

    @@ -155,132 +61,34 @@

    Optional@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.

    -

    -
    -

    Default

      +

    Default

    • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
    -
    -
    -

    Optional Readonly terminationProtection

    -
    terminationProtection?: boolean
    -

    Whether to enable termination protection for this stack.

    -
    -
    -

    Default

    false
-
    -
    -
    -

    Optional Readonly analyticsReporting

    -
    analyticsReporting?: boolean
    -

    Include runtime versioning information in this Stack

    -
    -
    -

    Default

    analyticsReporting setting of containing App, or value of -'aws:cdk:version-reporting' context key

    -
    -
    -

    Optional Readonly crossRegionReferences

    -
    crossRegionReferences?: boolean
    -

    Enable this flag to allow native cross region stack references.

    +

    Optional ReadonlyterminationProtection

    terminationProtection?: boolean

    Whether to enable termination protection for this stack.

    +

    Default

    false
+
    + +

    Optional ReadonlyanalyticsReporting

    analyticsReporting?: boolean

    Include runtime versioning information in this Stack

    +

    Default

    analyticsReporting setting of containing App, or value of +'aws:cdk:version-reporting' context key

    +

    Optional ReadonlycrossRegionReferences

    crossRegionReferences?: boolean

    Enable this flag to allow native cross region stack references.

    Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

    This feature is currently experimental

    -
    -
    -

    Default

    false
-
    -
    -
    -

    Optional Readonly permissionsBoundary

    -
    permissionsBoundary?: PermissionsBoundary
    -

    Options for applying a permissions boundary to all IAM Roles +

    Default

    false
+
    + +

    Optional ReadonlypermissionsBoundary

    permissionsBoundary?: PermissionsBoundary

    Options for applying a permissions boundary to all IAM Roles and Users created within this Stage

    -
    -
    -

    Default

    - no permissions boundary is applied
-
    -
    -
    -

    Optional Readonly suppressTemplateIndentation

    -
    suppressTemplateIndentation?: boolean
    -

    Enable this flag to suppress indentation in generated +

    Default

    - no permissions boundary is applied
+
    + +

    Optional ReadonlysuppressTemplateIndentation

    suppressTemplateIndentation?: boolean

    Enable this flag to suppress indentation in generated CloudFormation templates.

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used.

    -
    -
    -

    Default

      +

    Default

    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
    -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -

    On This Page

     -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/BuildImagePipelineProps.html b/interfaces/BuildImagePipelineProps.html index cacfaf3..bdc0e5c 100644 --- a/interfaces/BuildImagePipelineProps.html +++ b/interfaces/BuildImagePipelineProps.html @@ -1,123 +1,32 @@ -BuildImagePipelineProps | aws4embeddedlinux-cdk-lib
    -
    - -
    -
    -
    -
    - -

    Interface BuildImagePipelineProps

    -
    -

    Select options for the BuildImagePipelineStack.

    -
    -
    -
    -

    Hierarchy

    -
      -
    • StackProps -
        -
      • BuildImagePipelineProps
    -
    -
    -
    - -
    -
    -

    Properties

    -
    imageKind -dataBucket -repository -accessLoggingBucket? -serverAccessLogsPrefix? -artifactBucket? -description? -env? -stackName? -tags? -notificationArns? -synthesizer? -terminationProtection? -analyticsReporting? -crossRegionReferences? -permissionsBoundary? -suppressTemplateIndentation? -
    -
    -

    Properties

    -
    -

    Readonly imageKind

    -
    imageKind: Ubuntu22_04
    -

    The Image type to create.

    -
    -
    -
    -

    Readonly dataBucket

    -
    dataBucket: IBucket
    -

    The data bucket from the BuildImageDataStack

    -
    -
    -
    -

    Readonly repository

    -
    repository: IRepository
    -

    The ECR Repository to push to.

    -
    -
    -
    -

    Optional Readonly accessLoggingBucket

    -
    accessLoggingBucket?: Bucket
    -

    Access logging bucket to use

    -
    -
    -
    -

    Optional Readonly serverAccessLogsPrefix

    -
    serverAccessLogsPrefix?: string
    -

    Access logging prefix to use

    -
    -
    -
    -

    Optional Readonly artifactBucket

    -
    artifactBucket?: Bucket
    -

    Artifact bucket to use

    -
    -
    -
    -

    Optional Readonly description

    -
    description?: string
    -

    A description of the stack.

    -
    -
    -

    Default

    - No description.
-
    -
    -
    -

    Optional Readonly env

    -
    env?: Environment
    -

    The AWS environment (account/region) where this stack will be deployed.

    +BuildImagePipelineProps | aws4embeddedlinux-cdk-lib

    Interface BuildImagePipelineProps

    Select options for the BuildImagePipelineStack.

    +
    interface BuildImagePipelineProps {
        imageKind: Ubuntu22_04;
        dataBucket: IBucket;
        repository: IRepository;
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • BuildImagePipelineProps

    Properties

    imageKind +dataBucket +repository +accessLoggingBucket? +serverAccessLogsPrefix? +artifactBucket? +description? +env? +stackName? +tags? +notificationArns? +synthesizer? +terminationProtection? +analyticsReporting? +crossRegionReferences? +permissionsBoundary? +suppressTemplateIndentation? +

    Properties

    ReadonlyimageKind

    imageKind: Ubuntu22_04

    The Image type to create.

    +

    ReadonlydataBucket

    dataBucket: IBucket

    The data bucket from the BuildImageDataStack

    +

    Readonlyrepository

    repository: IRepository

    The ECR Repository to push to.

    +

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    +

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    +

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Default

    - No description.
+
    + +

    Optional Readonlyenv

    env?: Environment

    The AWS environment (account/region) where this stack will be deployed.

    Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables @@ -133,65 +42,27 @@

    Optionalec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the -environment's AWS partition, and other such enhancements.

    -

    -
    -

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
-
    +environment's AWS partition, and other such enhancements.

    +

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
+
    -

    Default

      +

    Default

    • The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
    -
    -
    -

    Optional Readonly stackName

    -
    stackName?: string
    -

    Name to deploy the stack with

    -
    -
    -

    Default

    - Derived from construct path.
-
    -
    -
    -

    Optional Readonly tags

    -
    tags?: {
        [key: string]: string;
    }
    -

    Stack tags that will be applied to all the taggable resources and the stack itself.

    -
    -
    -

    Type declaration

    -
      -
    • -
      [key: string]: string
    -
    -

    Default

    {}
-
    -
    -
    -

    Optional Readonly notificationArns

    -
    notificationArns?: string[]
    -

    SNS Topic ARNs that will receive stack events.

    -
    -
    -

    Default

    - no notfication arns.
-
    -
    -
    -

    Optional Readonly synthesizer

    -
    synthesizer?: IStackSynthesizer
    -

    Synthesis method to use while deploying this stack

    +

    Optional ReadonlystackName

    stackName?: string

    Name to deploy the stack with

    +

    Default

    - Derived from construct path.
+
    + +

    Optional Readonlytags

    tags?: { [key: string]: string }

    Stack tags that will be applied to all the taggable resources and the stack itself.

    +

    Default

    {}
+
    + +

    Optional ReadonlynotificationArns

    notificationArns?: string[]

    SNS Topic ARNs that will receive stack events.

    +

    Default

    - no notfication arns.
+
    + +

    Optional Readonlysynthesizer

    synthesizer?: IStackSynthesizer

    Synthesis method to use while deploying this stack

    The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

    @@ -200,137 +71,34 @@

    Optional@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.

    -

    -
    -

    Default

      +

    Default

    • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
    -
    -
    -

    Optional Readonly terminationProtection

    -
    terminationProtection?: boolean
    -

    Whether to enable termination protection for this stack.

    -
    -
    -

    Default

    false
-
    -
    -
    -

    Optional Readonly analyticsReporting

    -
    analyticsReporting?: boolean
    -

    Include runtime versioning information in this Stack

    -
    -
    -

    Default

    analyticsReporting setting of containing App, or value of -'aws:cdk:version-reporting' context key

    -
    -
    -

    Optional Readonly crossRegionReferences

    -
    crossRegionReferences?: boolean
    -

    Enable this flag to allow native cross region stack references.

    +

    Optional ReadonlyterminationProtection

    terminationProtection?: boolean

    Whether to enable termination protection for this stack.

    +

    Default

    false
+
    + +

    Optional ReadonlyanalyticsReporting

    analyticsReporting?: boolean

    Include runtime versioning information in this Stack

    +

    Default

    analyticsReporting setting of containing App, or value of +'aws:cdk:version-reporting' context key

    +

    Optional ReadonlycrossRegionReferences

    crossRegionReferences?: boolean

    Enable this flag to allow native cross region stack references.

    Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

    This feature is currently experimental

    -
    -
    -

    Default

    false
-
    -
    -
    -

    Optional Readonly permissionsBoundary

    -
    permissionsBoundary?: PermissionsBoundary
    -

    Options for applying a permissions boundary to all IAM Roles +

    Default

    false
+
    + +

    Optional ReadonlypermissionsBoundary

    permissionsBoundary?: PermissionsBoundary

    Options for applying a permissions boundary to all IAM Roles and Users created within this Stage

    -
    -
    -

    Default

    - no permissions boundary is applied
-
    -
    -
    -

    Optional Readonly suppressTemplateIndentation

    -
    suppressTemplateIndentation?: boolean
    -

    Enable this flag to suppress indentation in generated +

    Default

    - no permissions boundary is applied
+
    + +

    Optional ReadonlysuppressTemplateIndentation

    suppressTemplateIndentation?: boolean

    Enable this flag to suppress indentation in generated CloudFormation templates.

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used.

    -
    -
    -

    Default

      +

    Default

    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
    -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -

    On This Page

     -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/EmbeddedLinuxCodebuildProjectProps.html b/interfaces/EmbeddedLinuxCodebuildProjectProps.html index a085334..45338f8 100644 --- a/interfaces/EmbeddedLinuxCodebuildProjectProps.html +++ b/interfaces/EmbeddedLinuxCodebuildProjectProps.html @@ -1,168 +1,42 @@ -EmbeddedLinuxCodebuildProjectProps | aws4embeddedlinux-cdk-lib
    -
    - -
    -
    -
    -
    - -

    Interface EmbeddedLinuxCodebuildProjectProps

    -
    -

    Properties to allow customizing the build.

    -
    -
    -
    -

    Hierarchy

    -
      -
    • StackProps -
        -
      • EmbeddedLinuxCodebuildProjectProps
    -
    -
    -
    - -
    -
    -

    Properties

    -
    imageRepo -imageTag? -vpc -projectKind? -layerRepoName? -buildPolicyAdditions? -accessLoggingBucket? -serverAccessLogsPrefix? -artifactBucket? -outputBucket? -subDirectoryName? -description? -env? -stackName? -tags? -notificationArns? -synthesizer? -terminationProtection? -analyticsReporting? -crossRegionReferences? -permissionsBoundary? -suppressTemplateIndentation? -
    -
    -

    Properties

    -
    -

    Readonly imageRepo

    -
    imageRepo: IRepository
    -

    ECR Repository where the Build Host Image resides.

    -
    -
    -
    -

    Optional Readonly imageTag

    -
    imageTag?: string
    -

    Tag for the Build Host Image

    -
    -
    -
    -

    Readonly vpc

    -
    vpc: IVpc
    -

    VPC where the networking setup resides.

    -
    -
    -
    -

    Optional Readonly projectKind

    -
    projectKind?: ProjectKind
    -

    The type of project being built.

    -
    -
    -
    -

    Optional Readonly layerRepoName

    -
    layerRepoName?: string
    -

    A name for the layer-repo that is created. Default is 'layer-repo'

    -
    -
    -
    -

    Optional Readonly buildPolicyAdditions

    -
    buildPolicyAdditions?: PolicyStatement[]
    -

    Additional policy statements to add to the build project.

    -
    -
    -
    -

    Optional Readonly accessLoggingBucket

    -
    accessLoggingBucket?: Bucket
    -

    Access logging bucket to use

    -
    -
    -
    -

    Optional Readonly serverAccessLogsPrefix

    -
    serverAccessLogsPrefix?: string
    -

    Access logging prefix to use

    -
    -
    -
    -

    Optional Readonly artifactBucket

    -
    artifactBucket?: Bucket
    -

    Artifact bucket to use

    -
    -
    -
    -

    Optional Readonly outputBucket

    -
    outputBucket?: Bucket | VMImportBucket
    -

    Output bucket to use

    -
    -
    -
    -

    Optional Readonly subDirectoryName

    -
    subDirectoryName?: string
    -

    Prefix for S3 object within bucket

    -
    -
    -
    -

    Optional Readonly description

    -
    description?: string
    -

    A description of the stack.

    -
    -
    -

    Default

    - No description.
-
    -
    -
    -

    Optional Readonly env

    -
    env?: Environment
    -

    The AWS environment (account/region) where this stack will be deployed.

    +EmbeddedLinuxCodebuildProjectProps | aws4embeddedlinux-cdk-lib

    Interface EmbeddedLinuxCodebuildProjectProps

    Properties to allow customizing the build.

    +
    interface EmbeddedLinuxCodebuildProjectProps {
        imageRepo: IRepository;
        imageTag?: string;
        vpc: IVpc;
        projectKind?: ProjectKind;
        layerRepoName?: string;
        buildPolicyAdditions?: PolicyStatement[];
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        outputBucket?: Bucket | VMImportBucket;
        subDirectoryName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxCodebuildProjectProps

    Properties

    imageRepo +imageTag? +vpc +projectKind? +layerRepoName? +buildPolicyAdditions? +accessLoggingBucket? +serverAccessLogsPrefix? +artifactBucket? +outputBucket? +subDirectoryName? +description? +env? +stackName? +tags? +notificationArns? +synthesizer? +terminationProtection? +analyticsReporting? +crossRegionReferences? +permissionsBoundary? +suppressTemplateIndentation? +

    Properties

    ReadonlyimageRepo

    imageRepo: IRepository

    ECR Repository where the Build Host Image resides.

    +

    Optional ReadonlyimageTag

    imageTag?: string

    Tag for the Build Host Image

    +

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    +

    Optional ReadonlyprojectKind

    projectKind?: ProjectKind

    The type of project being built.

    +

    Optional ReadonlylayerRepoName

    layerRepoName?: string

    A name for the layer-repo that is created. Default is 'layer-repo'

    +

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    +

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    +

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    +

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    +

    Optional ReadonlyoutputBucket

    outputBucket?: Bucket | VMImportBucket

    Output bucket to use

    +

    Optional ReadonlysubDirectoryName

    subDirectoryName?: string

    Prefix for S3 object within bucket

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Default

    - No description.
+
    + +

    Optional Readonlyenv

    env?: Environment

    The AWS environment (account/region) where this stack will be deployed.

    Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables @@ -178,65 +52,27 @@

    Optionalec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the -environment's AWS partition, and other such enhancements.

    -

    -
    -

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
-
    +environment's AWS partition, and other such enhancements.

    +

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
+
    -

    Default

      +

    Default

    • The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
    -
    -
    -

    Optional Readonly stackName

    -
    stackName?: string
    -

    Name to deploy the stack with

    -
    -
    -

    Default

    - Derived from construct path.
-
    -
    -
    -

    Optional Readonly tags

    -
    tags?: {
        [key: string]: string;
    }
    -

    Stack tags that will be applied to all the taggable resources and the stack itself.

    -
    -
    -

    Type declaration

    -
      -
    • -
      [key: string]: string
    -
    -

    Default

    {}
-
    -
    -
    -

    Optional Readonly notificationArns

    -
    notificationArns?: string[]
    -

    SNS Topic ARNs that will receive stack events.

    -
    -
    -

    Default

    - no notfication arns.
-
    -
    -
    -

    Optional Readonly synthesizer

    -
    synthesizer?: IStackSynthesizer
    -

    Synthesis method to use while deploying this stack

    +

    Optional ReadonlystackName

    stackName?: string

    Name to deploy the stack with

    +

    Default

    - Derived from construct path.
+
    + +

    Optional Readonlytags

    tags?: { [key: string]: string }

    Stack tags that will be applied to all the taggable resources and the stack itself.

    +

    Default

    {}
+
    + +

    Optional ReadonlynotificationArns

    notificationArns?: string[]

    SNS Topic ARNs that will receive stack events.

    +

    Default

    - no notfication arns.
+
    + +

    Optional Readonlysynthesizer

    synthesizer?: IStackSynthesizer

    Synthesis method to use while deploying this stack

    The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

    @@ -245,142 +81,34 @@

    Optional@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.

    -

    -
    -

    Default

      +

    Default

    • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
    -
    -
    -

    Optional Readonly terminationProtection

    -
    terminationProtection?: boolean
    -

    Whether to enable termination protection for this stack.

    -
    -
    -

    Default

    false
-
    -
    -
    -

    Optional Readonly analyticsReporting

    -
    analyticsReporting?: boolean
    -

    Include runtime versioning information in this Stack

    -
    -
    -

    Default

    analyticsReporting setting of containing App, or value of -'aws:cdk:version-reporting' context key

    -
    -
    -

    Optional Readonly crossRegionReferences

    -
    crossRegionReferences?: boolean
    -

    Enable this flag to allow native cross region stack references.

    +

    Optional ReadonlyterminationProtection

    terminationProtection?: boolean

    Whether to enable termination protection for this stack.

    +

    Default

    false
+
    + +

    Optional ReadonlyanalyticsReporting

    analyticsReporting?: boolean

    Include runtime versioning information in this Stack

    +

    Default

    analyticsReporting setting of containing App, or value of +'aws:cdk:version-reporting' context key

    +

    Optional ReadonlycrossRegionReferences

    crossRegionReferences?: boolean

    Enable this flag to allow native cross region stack references.

    Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

    This feature is currently experimental

    -
    -
    -

    Default

    false
-
    -
    -
    -

    Optional Readonly permissionsBoundary

    -
    permissionsBoundary?: PermissionsBoundary
    -

    Options for applying a permissions boundary to all IAM Roles +

    Default

    false
+
    + +

    Optional ReadonlypermissionsBoundary

    permissionsBoundary?: PermissionsBoundary

    Options for applying a permissions boundary to all IAM Roles and Users created within this Stage

    -
    -
    -

    Default

    - no permissions boundary is applied
-
    -
    -
    -

    Optional Readonly suppressTemplateIndentation

    -
    suppressTemplateIndentation?: boolean
    -

    Enable this flag to suppress indentation in generated +

    Default

    - no permissions boundary is applied
+
    + +

    Optional ReadonlysuppressTemplateIndentation

    suppressTemplateIndentation?: boolean

    Enable this flag to suppress indentation in generated CloudFormation templates.

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used.

    -
    -
    -

    Default

      +

    Default

    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
    -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -

    On This Page

     -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/EmbeddedLinuxPipelineProps.html b/interfaces/EmbeddedLinuxPipelineProps.html index 089add3..7c323c0 100644 --- a/interfaces/EmbeddedLinuxPipelineProps.html +++ b/interfaces/EmbeddedLinuxPipelineProps.html @@ -1,168 +1,42 @@ -EmbeddedLinuxPipelineProps | aws4embeddedlinux-cdk-lib
    -
    - -
    -
    -
    -
    - -

    Interface EmbeddedLinuxPipelineProps

    -
    -

    Properties to allow customizing the build.

    -
    -
    -
    -

    Hierarchy

    -
      -
    • StackProps -
        -
      • EmbeddedLinuxPipelineProps
    -
    -
    -
    - -
    -
    -

    Properties

    -
    imageRepo -imageTag? -vpc -projectKind? -layerRepoName? -buildPolicyAdditions? -accessLoggingBucket? -serverAccessLogsPrefix? -artifactBucket? -outputBucket? -subDirectoryName? -description? -env? -stackName? -tags? -notificationArns? -synthesizer? -terminationProtection? -analyticsReporting? -crossRegionReferences? -permissionsBoundary? -suppressTemplateIndentation? -
    -
    -

    Properties

    -
    -

    Readonly imageRepo

    -
    imageRepo: IRepository
    -

    ECR Repository where the Build Host Image resides.

    -
    -
    -
    -

    Optional Readonly imageTag

    -
    imageTag?: string
    -

    Tag for the Build Host Image

    -
    -
    -
    -

    Readonly vpc

    -
    vpc: IVpc
    -

    VPC where the networking setup resides.

    -
    -
    -
    -

    Optional Readonly projectKind

    -
    projectKind?: ProjectKind
    -

    The type of project being built.

    -
    -
    -
    -

    Optional Readonly layerRepoName

    -
    layerRepoName?: string
    -

    A name for the layer-repo that is created. Default is 'layer-repo'

    -
    -
    -
    -

    Optional Readonly buildPolicyAdditions

    -
    buildPolicyAdditions?: PolicyStatement[]
    -

    Additional policy statements to add to the build project.

    -
    -
    -
    -

    Optional Readonly accessLoggingBucket

    -
    accessLoggingBucket?: Bucket
    -

    Access logging bucket to use

    -
    -
    -
    -

    Optional Readonly serverAccessLogsPrefix

    -
    serverAccessLogsPrefix?: string
    -

    Access logging prefix to use

    -
    -
    -
    -

    Optional Readonly artifactBucket

    -
    artifactBucket?: Bucket
    -

    Artifact bucket to use

    -
    -
    -
    -

    Optional Readonly outputBucket

    -
    outputBucket?: Bucket | VMImportBucket
    -

    Output bucket to use

    -
    -
    -
    -

    Optional Readonly subDirectoryName

    -
    subDirectoryName?: string
    -

    Prefix for S3 object within bucket

    -
    -
    -
    -

    Optional Readonly description

    -
    description?: string
    -

    A description of the stack.

    -
    -
    -

    Default

    - No description.
-
    -
    -
    -

    Optional Readonly env

    -
    env?: Environment
    -

    The AWS environment (account/region) where this stack will be deployed.

    +EmbeddedLinuxPipelineProps | aws4embeddedlinux-cdk-lib

    Interface EmbeddedLinuxPipelineProps

    Properties to allow customizing the build.

    +
    interface EmbeddedLinuxPipelineProps {
        imageRepo: IRepository;
        imageTag?: string;
        vpc: IVpc;
        projectKind?: ProjectKind;
        layerRepoName?: string;
        buildPolicyAdditions?: PolicyStatement[];
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        outputBucket?: Bucket | VMImportBucket;
        subDirectoryName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxPipelineProps

    Properties

    imageRepo +imageTag? +vpc +projectKind? +layerRepoName? +buildPolicyAdditions? +accessLoggingBucket? +serverAccessLogsPrefix? +artifactBucket? +outputBucket? +subDirectoryName? +description? +env? +stackName? +tags? +notificationArns? +synthesizer? +terminationProtection? +analyticsReporting? +crossRegionReferences? +permissionsBoundary? +suppressTemplateIndentation? +

    Properties

    ReadonlyimageRepo

    imageRepo: IRepository

    ECR Repository where the Build Host Image resides.

    +

    Optional ReadonlyimageTag

    imageTag?: string

    Tag for the Build Host Image

    +

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    +

    Optional ReadonlyprojectKind

    projectKind?: ProjectKind

    The type of project being built.

    +

    Optional ReadonlylayerRepoName

    layerRepoName?: string

    A name for the layer-repo that is created. Default is 'layer-repo'

    +

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    +

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    +

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    +

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    +

    Optional ReadonlyoutputBucket

    outputBucket?: Bucket | VMImportBucket

    Output bucket to use

    +

    Optional ReadonlysubDirectoryName

    subDirectoryName?: string

    Prefix for S3 object within bucket

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Default

    - No description.
+
    + +

    Optional Readonlyenv

    env?: Environment

    The AWS environment (account/region) where this stack will be deployed.

    Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables @@ -178,65 +52,27 @@

    Optionalec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the -environment's AWS partition, and other such enhancements.

    -

    -
    -

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
-
    +environment's AWS partition, and other such enhancements.

    +

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
+
    -

    Default

      +

    Default

    • The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
    -
    -
    -

    Optional Readonly stackName

    -
    stackName?: string
    -

    Name to deploy the stack with

    -
    -
    -

    Default

    - Derived from construct path.
-
    -
    -
    -

    Optional Readonly tags

    -
    tags?: {
        [key: string]: string;
    }
    -

    Stack tags that will be applied to all the taggable resources and the stack itself.

    -
    -
    -

    Type declaration

    -
      -
    • -
      [key: string]: string
    -
    -

    Default

    {}
-
    -
    -
    -

    Optional Readonly notificationArns

    -
    notificationArns?: string[]
    -

    SNS Topic ARNs that will receive stack events.

    -
    -
    -

    Default

    - no notfication arns.
-
    -
    -
    -

    Optional Readonly synthesizer

    -
    synthesizer?: IStackSynthesizer
    -

    Synthesis method to use while deploying this stack

    +

    Optional ReadonlystackName

    stackName?: string

    Name to deploy the stack with

    +

    Default

    - Derived from construct path.
+
    + +

    Optional Readonlytags

    tags?: { [key: string]: string }

    Stack tags that will be applied to all the taggable resources and the stack itself.

    +

    Default

    {}
+
    + +

    Optional ReadonlynotificationArns

    notificationArns?: string[]

    SNS Topic ARNs that will receive stack events.

    +

    Default

    - no notfication arns.
+
    + +

    Optional Readonlysynthesizer

    synthesizer?: IStackSynthesizer

    Synthesis method to use while deploying this stack

    The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

    @@ -245,142 +81,34 @@

    Optional@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.

    -

    -
    -

    Default

      +

    Default

    • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
    -
    -
    -

    Optional Readonly terminationProtection

    -
    terminationProtection?: boolean
    -

    Whether to enable termination protection for this stack.

    -
    -
    -

    Default

    false
-
    -
    -
    -

    Optional Readonly analyticsReporting

    -
    analyticsReporting?: boolean
    -

    Include runtime versioning information in this Stack

    -
    -
    -

    Default

    analyticsReporting setting of containing App, or value of -'aws:cdk:version-reporting' context key

    -
    -
    -

    Optional Readonly crossRegionReferences

    -
    crossRegionReferences?: boolean
    -

    Enable this flag to allow native cross region stack references.

    +

    Optional ReadonlyterminationProtection

    terminationProtection?: boolean

    Whether to enable termination protection for this stack.

    +

    Default

    false
+
    + +

    Optional ReadonlyanalyticsReporting

    analyticsReporting?: boolean

    Include runtime versioning information in this Stack

    +

    Default

    analyticsReporting setting of containing App, or value of +'aws:cdk:version-reporting' context key

    +

    Optional ReadonlycrossRegionReferences

    crossRegionReferences?: boolean

    Enable this flag to allow native cross region stack references.

    Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

    This feature is currently experimental

    -
    -
    -

    Default

    false
-
    -
    -
    -

    Optional Readonly permissionsBoundary

    -
    permissionsBoundary?: PermissionsBoundary
    -

    Options for applying a permissions boundary to all IAM Roles +

    Default

    false
+
    + +

    Optional ReadonlypermissionsBoundary

    permissionsBoundary?: PermissionsBoundary

    Options for applying a permissions boundary to all IAM Roles and Users created within this Stage

    -
    -
    -

    Default

    - no permissions boundary is applied
-
    -
    -
    -

    Optional Readonly suppressTemplateIndentation

    -
    suppressTemplateIndentation?: boolean
    -

    Enable this flag to suppress indentation in generated +

    Default

    - no permissions boundary is applied
+
    + +

    Optional ReadonlysuppressTemplateIndentation

    suppressTemplateIndentation?: boolean

    Enable this flag to suppress indentation in generated CloudFormation templates.

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used.

    -
    -
    -

    Default

      +

    Default

    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
    -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -

    On This Page

     -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html index 7351de7..53ce200 100644 --- a/interfaces/SourceRepoProps.html +++ b/interfaces/SourceRepoProps.html @@ -1,83 +1,23 @@ -SourceRepoProps | aws4embeddedlinux-cdk-lib
    -
    - -
    -
    -
    -
    - -

    Interface SourceRepoProps

    -
    -

    Hierarchy

    -
      -
    • StackProps -
        -
      • SourceRepoProps
    -
    -
    -
    - -
    -
    -

    Properties

    -
    repoName -kind -description? -env? -stackName? -tags? -notificationArns? -synthesizer? -terminationProtection? -analyticsReporting? -crossRegionReferences? -permissionsBoundary? -suppressTemplateIndentation? -
    -
    -

    Properties

    -
    -

    Readonly repoName

    -
    repoName: string
    -

    The name of the CodeCommit Repository created.

    -
    -
    -
    -

    Readonly kind

    -
    kind: ProjectKind
    -

    The type of project to seed this repository with.

    -
    -
    -
    -

    Optional Readonly description

    -
    description?: string
    -

    A description of the stack.

    -
    -
    -

    Default

    - No description.
-
    -
    -
    -

    Optional Readonly env

    -
    env?: Environment
    -

    The AWS environment (account/region) where this stack will be deployed.

    +SourceRepoProps | aws4embeddedlinux-cdk-lib

    Interface SourceRepoProps

    interface SourceRepoProps {
        repoName: string;
        kind: ProjectKind;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • SourceRepoProps

    Properties

    repoName +kind +description? +env? +stackName? +tags? +notificationArns? +synthesizer? +terminationProtection? +analyticsReporting? +crossRegionReferences? +permissionsBoundary? +suppressTemplateIndentation? +

    Properties

    ReadonlyrepoName

    repoName: string

    The name of the CodeCommit Repository created.

    +

    Readonlykind

    kind: ProjectKind

    The type of project to seed this repository with.

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Default

    - No description.
+
    + +

    Optional Readonlyenv

    env?: Environment

    The AWS environment (account/region) where this stack will be deployed.

    Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables @@ -93,65 +33,27 @@

    Optionalec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the -environment's AWS partition, and other such enhancements.

    -

    -
    -

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
-
    +environment's AWS partition, and other such enhancements.

    +

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
+
    -

    Default

      +

    Default

    • The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
    -
    -
    -

    Optional Readonly stackName

    -
    stackName?: string
    -

    Name to deploy the stack with

    -
    -
    -

    Default

    - Derived from construct path.
-
    -
    -
    -

    Optional Readonly tags

    -
    tags?: {
        [key: string]: string;
    }
    -

    Stack tags that will be applied to all the taggable resources and the stack itself.

    -
    -
    -

    Type declaration

    -
      -
    • -
      [key: string]: string
    -
    -

    Default

    {}
-
    -
    -
    -

    Optional Readonly notificationArns

    -
    notificationArns?: string[]
    -

    SNS Topic ARNs that will receive stack events.

    -
    -
    -

    Default

    - no notfication arns.
-
    -
    -
    -

    Optional Readonly synthesizer

    -
    synthesizer?: IStackSynthesizer
    -

    Synthesis method to use while deploying this stack

    +

    Optional ReadonlystackName

    stackName?: string

    Name to deploy the stack with

    +

    Default

    - Derived from construct path.
+
    + +

    Optional Readonlytags

    tags?: { [key: string]: string }

    Stack tags that will be applied to all the taggable resources and the stack itself.

    +

    Default

    {}
+
    + +

    Optional ReadonlynotificationArns

    notificationArns?: string[]

    SNS Topic ARNs that will receive stack events.

    +

    Default

    - no notfication arns.
+
    + +

    Optional Readonlysynthesizer

    synthesizer?: IStackSynthesizer

    Synthesis method to use while deploying this stack

    The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

    @@ -160,133 +62,34 @@

    Optional@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.

    -

    -
    -

    Default

      +

    Default

    • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
    -
    -
    -

    Optional Readonly terminationProtection

    -
    terminationProtection?: boolean
    -

    Whether to enable termination protection for this stack.

    -
    -
    -

    Default

    false
-
    -
    -
    -

    Optional Readonly analyticsReporting

    -
    analyticsReporting?: boolean
    -

    Include runtime versioning information in this Stack

    -
    -
    -

    Default

    analyticsReporting setting of containing App, or value of -'aws:cdk:version-reporting' context key

    -
    -
    -

    Optional Readonly crossRegionReferences

    -
    crossRegionReferences?: boolean
    -

    Enable this flag to allow native cross region stack references.

    +

    Optional ReadonlyterminationProtection

    terminationProtection?: boolean

    Whether to enable termination protection for this stack.

    +

    Default

    false
+
    + +

    Optional ReadonlyanalyticsReporting

    analyticsReporting?: boolean

    Include runtime versioning information in this Stack

    +

    Default

    analyticsReporting setting of containing App, or value of +'aws:cdk:version-reporting' context key

    +

    Optional ReadonlycrossRegionReferences

    crossRegionReferences?: boolean

    Enable this flag to allow native cross region stack references.

    Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

    This feature is currently experimental

    -
    -
    -

    Default

    false
-
    -
    -
    -

    Optional Readonly permissionsBoundary

    -
    permissionsBoundary?: PermissionsBoundary
    -

    Options for applying a permissions boundary to all IAM Roles +

    Default

    false
+
    + +

    Optional ReadonlypermissionsBoundary

    permissionsBoundary?: PermissionsBoundary

    Options for applying a permissions boundary to all IAM Roles and Users created within this Stage

    -
    -
    -

    Default

    - no permissions boundary is applied
-
    -
    -
    -

    Optional Readonly suppressTemplateIndentation

    -
    suppressTemplateIndentation?: boolean
    -

    Enable this flag to suppress indentation in generated +

    Default

    - no permissions boundary is applied
+
    + +

    Optional ReadonlysuppressTemplateIndentation

    suppressTemplateIndentation?: boolean

    Enable this flag to suppress indentation in generated CloudFormation templates.

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used.

    -
    -
    -

    Default

      +

    Default

    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
    -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -

    On This Page

     -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/media/CONTRIBUTING.md b/media/CONTRIBUTING.md new file mode 100644 index 0000000..c4b6a1c --- /dev/null +++ b/media/CONTRIBUTING.md @@ -0,0 +1,59 @@ +# Contributing Guidelines + +Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional +documentation, we greatly value feedback and contributions from our community. + +Please read through this document before submitting any issues or pull requests to ensure we have all the necessary +information to effectively respond to your bug report or contribution. + + +## Reporting Bugs/Feature Requests + +We welcome you to use the GitHub issue tracker to report bugs or suggest features. + +When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already +reported the issue. Please try to include as much information as you can. Details like these are incredibly useful: + +* A reproducible test case or series of steps +* The version of our code being used +* Any modifications you've made relevant to the bug +* Anything unusual about your environment or deployment + + +## Contributing via Pull Requests +Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that: + +1. You are working against the latest source on the *main* branch. +2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already. +3. You open an issue to discuss any significant work - we would hate for your time to be wasted. + +To send us a pull request, please: + +1. Fork the repository. +2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change. +3. Ensure local tests pass. +4. Commit to your fork using clear commit messages. +5. Send us a pull request, answering any default questions in the pull request interface. +6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation. + +GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and +[creating a pull request](https://help.github.com/articles/creating-a-pull-request/). + + +## Finding contributions to work on +Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start. + + +## Code of Conduct +This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). +For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact +opensource-codeofconduct@amazon.com with any additional questions or comments. + + +## Security issue notifications +If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue. + + +## Licensing + +See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. diff --git a/media/LICENSE b/media/LICENSE new file mode 100644 index 0000000..56a66b6 --- /dev/null +++ b/media/LICENSE @@ -0,0 +1,16 @@ +MIT No Attribution + +Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/media/SECURITY.md b/media/SECURITY.md new file mode 100644 index 0000000..75a3b51 --- /dev/null +++ b/media/SECURITY.md @@ -0,0 +1,11 @@ +## Reporting Security Issues + +We take all security reports seriously. +When we receive such reports, +we will investigate and subsequently address +any potential vulnerabilities as quickly as possible. +If you discover a potential security issue in this project, +please notify AWS/Amazon Security via our +[vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/) +or directly via email to [AWS Security](mailto:aws-security@amazon.com). +Please do *not* create a public GitHub issue in this project. diff --git a/media/architecture.svg b/media/architecture.svg new file mode 100644 index 0000000..212e576 --- /dev/null +++ b/media/architecture.svg @@ -0,0 +1,4 @@ + + + +
    AWS Account
    AWS Account
    CodePipeline
    CodePipeline
    Build Artifacts
    Build Artifacts
    Build and Download Cache
    Build and Download Cache
    CodeBuild
    CodeBuild
    Update Config
    Update Config
    Builder
    Build...
    CodeCommit
    Repository
    CodeCommit...
    Download Sources
    Download Sources
    Upstream Package Sources
    Upstream Package Sourc...
    S3
    S3
    EFS
    EFS
    Download Metadata
    Download Metadata
    Upstream Layers
    Upstream Layers    Text is not SVG - cannot display     diff --git a/modules.html b/modules.html index bb8c1f8..4359cdc 100644 --- a/modules.html +++ b/modules.html @@ -1,75 +1 @@ -aws4embeddedlinux-cdk-lib
    -
    - -
    -
    -
    -
    -

    aws4embeddedlinux-cdk-lib

    -
    -
    -

    Index

    -
    -

    Enumerations

    -
    ImageKind -ProjectKind -
    -
    -

    Classes

    -
    BuildImageDataStack -BuildImagePipelineStack -BuildImageRepoStack -SourceRepo -EmbeddedLinuxCodebuildProjectStack -EmbeddedLinuxPipelineStack -PipelineNetworkStack -
    -
    -

    Interfaces

    -
    BuildImageDataProps -BuildImagePipelineProps -SourceRepoProps -EmbeddedLinuxCodebuildProjectProps -EmbeddedLinuxPipelineProps -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +aws4embeddedlinux-cdk-lib

    aws4embeddedlinux-cdk-lib

    Enumerations

    ImageKind
    ProjectKind

    Classes

    BuildImageDataStack
    BuildImagePipelineStack
    BuildImageRepoStack
    SourceRepo
    EmbeddedLinuxCodebuildProjectStack
    EmbeddedLinuxPipelineStack
    PipelineNetworkStack

    Interfaces

    BuildImageDataProps
    BuildImagePipelineProps
    SourceRepoProps
    EmbeddedLinuxCodebuildProjectProps
    EmbeddedLinuxPipelineProps

    Settings

    Member Visibility

    On This Page

    Enumerations
    Classes
    Interfaces
    From f5556b0d18c3fcf3be049f28effb35fb0f337a26 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Wed, 22 Jan 2025 13:49:28 +0000 Subject: [PATCH 23/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@d671b69a1143b36553a27c8ba8?= =?UTF-8?q?a89de1602689e2=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/BuildImageDataStack.html | 6 ++--- classes/BuildImagePipelineStack.html | 4 ++-- classes/BuildImageRepoStack.html | 6 ++--- .../EmbeddedLinuxCodebuildProjectStack.html | 4 ++-- classes/EmbeddedLinuxPipelineStack.html | 4 ++-- classes/PipelineNetworkStack.html | 6 ++--- classes/SourceRepo.html | 6 ++--- enums/ImageKind.html | 4 ++-- enums/ProjectKind.html | 16 ++++++------- interfaces/BuildImageDataProps.html | 4 ++-- interfaces/BuildImagePipelineProps.html | 14 +++++------ .../EmbeddedLinuxCodebuildProjectProps.html | 24 +++++++++---------- interfaces/EmbeddedLinuxPipelineProps.html | 24 +++++++++---------- interfaces/SourceRepoProps.html | 6 ++--- 14 files changed, 64 insertions(+), 64 deletions(-) diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html index 129659a..5497610 100644 --- a/classes/BuildImageDataStack.html +++ b/classes/BuildImageDataStack.html @@ -1,5 +1,5 @@ BuildImageDataStack | aws4embeddedlinux-cdk-lib

    Class BuildImageDataStack

    Input (Source) data for our BuildImagePipelineStack.

    -

    Hierarchy

    • Stack
      • BuildImageDataStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • BuildImageDataStack

    Constructors

    constructor

    Properties

    bucket tags templateOptions @@ -50,8 +50,8 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlybucket

    bucket: IBucket

    The bucket which will be consumed by the BuildImagePipelineStack.

    -

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlybucket

    bucket: IBucket

    The bucket which will be consumed by the BuildImagePipelineStack.

    +

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/BuildImagePipelineStack.html b/classes/BuildImagePipelineStack.html index 8493d8e..cdb6e4c 100644 --- a/classes/BuildImagePipelineStack.html +++ b/classes/BuildImagePipelineStack.html @@ -1,7 +1,7 @@ BuildImagePipelineStack | aws4embeddedlinux-cdk-lib

    Class BuildImagePipelineStack

    The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

    For configuration options see BuildImagePipelineProps.

    -

    Hierarchy

    • Stack
      • BuildImagePipelineStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • BuildImagePipelineStack

    Constructors

    constructor

    Properties

    tags templateOptions region @@ -51,7 +51,7 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html index 0b73dba..66825a8 100644 --- a/classes/BuildImageRepoStack.html +++ b/classes/BuildImageRepoStack.html @@ -1,6 +1,6 @@ BuildImageRepoStack | aws4embeddedlinux-cdk-lib

    Class BuildImageRepoStack

    The ECR Repository to store build host images.

    This is the output of the BuildImagePipelineStack

    -

    Hierarchy

    • Stack
      • BuildImageRepoStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • BuildImageRepoStack

    Constructors

    constructor

    Properties

    repository tags templateOptions @@ -51,8 +51,8 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlyrepository

    repository: IRepository

    The respository to put the build host container in.

    -

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlyrepository

    repository: IRepository

    The respository to put the build host container in.

    +

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/EmbeddedLinuxCodebuildProjectStack.html b/classes/EmbeddedLinuxCodebuildProjectStack.html index a39d59f..b9a11b1 100644 --- a/classes/EmbeddedLinuxCodebuildProjectStack.html +++ b/classes/EmbeddedLinuxCodebuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodebuildProjectStack | aws4embeddedlinux-cdk-lib

    Class EmbeddedLinuxCodebuildProjectStack

    The stack for creating a build pipeline.

    See EmbeddedLinuxCodebuildProjectProps for configration options.

    -

    Hierarchy

    • Stack
      • EmbeddedLinuxCodebuildProjectStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • EmbeddedLinuxCodebuildProjectStack

    Constructors

    constructor

    Properties

    tags templateOptions region @@ -50,7 +50,7 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/EmbeddedLinuxPipelineStack.html b/classes/EmbeddedLinuxPipelineStack.html index 7e82dcf..88f2c05 100644 --- a/classes/EmbeddedLinuxPipelineStack.html +++ b/classes/EmbeddedLinuxPipelineStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxPipelineStack | aws4embeddedlinux-cdk-lib

    Class EmbeddedLinuxPipelineStack

    The stack for creating a build pipeline.

    See EmbeddedLinuxPipelineProps for configration options.

    -

    Hierarchy

    • Stack
      • EmbeddedLinuxPipelineStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • EmbeddedLinuxPipelineStack

    Constructors

    constructor

    Properties

    tags templateOptions region @@ -50,7 +50,7 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/PipelineNetworkStack.html b/classes/PipelineNetworkStack.html index 3224dd5..87a3288 100644 --- a/classes/PipelineNetworkStack.html +++ b/classes/PipelineNetworkStack.html @@ -1,7 +1,7 @@ PipelineNetworkStack | aws4embeddedlinux-cdk-lib

    Class PipelineNetworkStack

    The network resources to run the pipeline in.

    This stack is provided for when users do not have an existing VPC with private and public subnets for the pipeline.

    -

    Hierarchy

    • Stack
      • PipelineNetworkStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • PipelineNetworkStack

    Constructors

    constructor

    Properties

    vpc tags templateOptions @@ -52,8 +52,8 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlyvpc

    vpc: IVpc

    The VPC for the pipeline to reside in.

    -

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlyvpc

    vpc: IVpc

    The VPC for the pipeline to reside in.

    +

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html index 9c61233..25cef66 100644 --- a/classes/SourceRepo.html +++ b/classes/SourceRepo.html @@ -1,13 +1,13 @@ SourceRepo | aws4embeddedlinux-cdk-lib

    Class SourceRepo

    The repository for the Source Stage of the pipeline.

    The initial contents of this repository are seeded by the assets contained in the source-repo/ folder of this library.

    -

    Hierarchy

    • Construct
      • SourceRepo

    Constructors

    constructor +

    Hierarchy

    • Construct
      • SourceRepo

    Constructors

    constructor

    Properties

    repo node

    Methods

    isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlyrepo

    repo: Repository

    The CodeCommit Repo itself.

    -

    Readonlynode

    node: Node

    The tree node.

    +

    Constructors

    constructor

    Properties

    Readonlyrepo

    repo: Repository

    The CodeCommit Repo itself.

    +

    Readonlynode

    node: Node

    The tree node.

    Methods

    StaticisConstruct

    • isConstruct(x: any): x is Construct

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      diff --git a/enums/ImageKind.html b/enums/ImageKind.html index f29c626..fd8688c 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -1,4 +1,4 @@ ImageKind | aws4embeddedlinux-cdk-lib

      Enumeration ImageKind

      The type of Image to build on.

      -

      Enumeration Members

      Ubuntu22_04 +

      Enumeration Members

      Ubuntu22_04

      Enumeration Members

      Ubuntu22_04

      Ubuntu22_04: "ubuntu_22_04"

      Ubuntu 22.04 (LTS)

      -

      Settings

      Member Visibility

      On This Page

      Enumeration Members
      +

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html index 2dfdb6a..5a35903 100644 --- a/enums/ProjectKind.html +++ b/enums/ProjectKind.html @@ -1,5 +1,5 @@ ProjectKind | aws4embeddedlinux-cdk-lib

    Enumeration ProjectKind

    The kind of project built.

    -

    Enumeration Members

    Poky +

    Enumeration Members

    Poky MetaAwsDemo PokyAmi Kas @@ -7,10 +7,10 @@ NxpImx CodeBuild

    Enumeration Members

    Poky

    Poky: "poky"

    Build core-image-minimal from poky.

    -

    MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"

    Build the Qemu meta-aws Demonstration Distribution.

    -

    PokyAmi

    PokyAmi: "poky-ami"

    Build an EC2 AMI

    -

    Kas

    Kas: "kas"

    Build an kas based image

    -

    Renesas

    Renesas: "renesas"

    Build an Renesas image

    -

    NxpImx

    NxpImx: "nxp-imx"

    Build an IMX image using NXP layers.

    -

    CodeBuild

    CodeBuild: "codebuild"

    Build no pipeline, just CodeBuild project to connect with GitHub actions.

    -

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"

    Build the Qemu meta-aws Demonstration Distribution.

    +

    PokyAmi

    PokyAmi: "poky-ami"

    Build an EC2 AMI

    +

    Kas

    Kas: "kas"

    Build an kas based image

    +

    Renesas

    Renesas: "renesas"

    Build an Renesas image

    +

    NxpImx

    NxpImx: "nxp-imx"

    Build an IMX image using NXP layers.

    +

    CodeBuild

    CodeBuild: "codebuild"

    Build no pipeline, just CodeBuild project to connect with GitHub actions.

    +

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html index 7845234..486fd88 100644 --- a/interfaces/BuildImageDataProps.html +++ b/interfaces/BuildImageDataProps.html @@ -1,5 +1,5 @@ BuildImageDataProps | aws4embeddedlinux-cdk-lib

    Interface BuildImageDataProps

    Select options for the BuildImageDataStack.

    -
    interface BuildImageDataProps {
        bucketName: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • BuildImageDataProps

    Properties

    bucketName +
    interface BuildImageDataProps {
        bucketName: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • BuildImageDataProps

    Properties

    bucketName description? env? stackName? @@ -12,7 +12,7 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlybucketName

    bucketName: string

    The bucket name for image build sources. This must be globally unique.

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    diff --git a/interfaces/BuildImagePipelineProps.html b/interfaces/BuildImagePipelineProps.html index bdc0e5c..962d06e 100644 --- a/interfaces/BuildImagePipelineProps.html +++ b/interfaces/BuildImagePipelineProps.html @@ -1,5 +1,5 @@ BuildImagePipelineProps | aws4embeddedlinux-cdk-lib

    Interface BuildImagePipelineProps

    Select options for the BuildImagePipelineStack.

    -
    interface BuildImagePipelineProps {
        imageKind: Ubuntu22_04;
        dataBucket: IBucket;
        repository: IRepository;
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • BuildImagePipelineProps

    Properties

    imageKind +
    interface BuildImagePipelineProps {
        imageKind: Ubuntu22_04;
        dataBucket: IBucket;
        repository: IRepository;
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • BuildImagePipelineProps

    Properties

    imageKind dataBucket repository accessLoggingBucket? @@ -17,12 +17,12 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlyimageKind

    imageKind: Ubuntu22_04

    The Image type to create.

    -

    ReadonlydataBucket

    dataBucket: IBucket

    The data bucket from the BuildImageDataStack

    -

    Readonlyrepository

    repository: IRepository

    The ECR Repository to push to.

    -

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    -

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    -

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    ReadonlydataBucket

    dataBucket: IBucket

    The data bucket from the BuildImageDataStack

    +

    Readonlyrepository

    repository: IRepository

    The ECR Repository to push to.

    +

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    +

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    +

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    diff --git a/interfaces/EmbeddedLinuxCodebuildProjectProps.html b/interfaces/EmbeddedLinuxCodebuildProjectProps.html index 45338f8..2efaad8 100644 --- a/interfaces/EmbeddedLinuxCodebuildProjectProps.html +++ b/interfaces/EmbeddedLinuxCodebuildProjectProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodebuildProjectProps | aws4embeddedlinux-cdk-lib

    Interface EmbeddedLinuxCodebuildProjectProps

    Properties to allow customizing the build.

    -
    interface EmbeddedLinuxCodebuildProjectProps {
        imageRepo: IRepository;
        imageTag?: string;
        vpc: IVpc;
        projectKind?: ProjectKind;
        layerRepoName?: string;
        buildPolicyAdditions?: PolicyStatement[];
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        outputBucket?: Bucket | VMImportBucket;
        subDirectoryName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxCodebuildProjectProps

    Properties

    imageRepo +
    interface EmbeddedLinuxCodebuildProjectProps {
        imageRepo: IRepository;
        imageTag?: string;
        vpc: IVpc;
        projectKind?: ProjectKind;
        layerRepoName?: string;
        buildPolicyAdditions?: PolicyStatement[];
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        outputBucket?: Bucket | VMImportBucket;
        subDirectoryName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxCodebuildProjectProps

    Properties

    imageRepo imageTag? vpc projectKind? @@ -22,17 +22,17 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlyimageRepo

    imageRepo: IRepository

    ECR Repository where the Build Host Image resides.

    -

    Optional ReadonlyimageTag

    imageTag?: string

    Tag for the Build Host Image

    -

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    -

    Optional ReadonlyprojectKind

    projectKind?: ProjectKind

    The type of project being built.

    -

    Optional ReadonlylayerRepoName

    layerRepoName?: string

    A name for the layer-repo that is created. Default is 'layer-repo'

    -

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    -

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    -

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    -

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    -

    Optional ReadonlyoutputBucket

    outputBucket?: Bucket | VMImportBucket

    Output bucket to use

    -

    Optional ReadonlysubDirectoryName

    subDirectoryName?: string

    Prefix for S3 object within bucket

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Optional ReadonlyimageTag

    imageTag?: string

    Tag for the Build Host Image

    +

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    +

    Optional ReadonlyprojectKind

    projectKind?: ProjectKind

    The type of project being built.

    +

    Optional ReadonlylayerRepoName

    layerRepoName?: string

    A name for the layer-repo that is created. Default is 'layer-repo'

    +

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    +

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    +

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    +

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    +

    Optional ReadonlyoutputBucket

    outputBucket?: Bucket | VMImportBucket

    Output bucket to use

    +

    Optional ReadonlysubDirectoryName

    subDirectoryName?: string

    Prefix for S3 object within bucket

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    diff --git a/interfaces/EmbeddedLinuxPipelineProps.html b/interfaces/EmbeddedLinuxPipelineProps.html index 7c323c0..5865d6f 100644 --- a/interfaces/EmbeddedLinuxPipelineProps.html +++ b/interfaces/EmbeddedLinuxPipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxPipelineProps | aws4embeddedlinux-cdk-lib

    Interface EmbeddedLinuxPipelineProps

    Properties to allow customizing the build.

    -
    interface EmbeddedLinuxPipelineProps {
        imageRepo: IRepository;
        imageTag?: string;
        vpc: IVpc;
        projectKind?: ProjectKind;
        layerRepoName?: string;
        buildPolicyAdditions?: PolicyStatement[];
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        outputBucket?: Bucket | VMImportBucket;
        subDirectoryName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxPipelineProps

    Properties

    imageRepo +
    interface EmbeddedLinuxPipelineProps {
        imageRepo: IRepository;
        imageTag?: string;
        vpc: IVpc;
        projectKind?: ProjectKind;
        layerRepoName?: string;
        buildPolicyAdditions?: PolicyStatement[];
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        outputBucket?: Bucket | VMImportBucket;
        subDirectoryName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxPipelineProps

    Properties

    imageRepo imageTag? vpc projectKind? @@ -22,17 +22,17 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlyimageRepo

    imageRepo: IRepository

    ECR Repository where the Build Host Image resides.

    -

    Optional ReadonlyimageTag

    imageTag?: string

    Tag for the Build Host Image

    -

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    -

    Optional ReadonlyprojectKind

    projectKind?: ProjectKind

    The type of project being built.

    -

    Optional ReadonlylayerRepoName

    layerRepoName?: string

    A name for the layer-repo that is created. Default is 'layer-repo'

    -

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    -

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    -

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    -

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    -

    Optional ReadonlyoutputBucket

    outputBucket?: Bucket | VMImportBucket

    Output bucket to use

    -

    Optional ReadonlysubDirectoryName

    subDirectoryName?: string

    Prefix for S3 object within bucket

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Optional ReadonlyimageTag

    imageTag?: string

    Tag for the Build Host Image

    +

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    +

    Optional ReadonlyprojectKind

    projectKind?: ProjectKind

    The type of project being built.

    +

    Optional ReadonlylayerRepoName

    layerRepoName?: string

    A name for the layer-repo that is created. Default is 'layer-repo'

    +

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    +

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    +

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    +

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    +

    Optional ReadonlyoutputBucket

    outputBucket?: Bucket | VMImportBucket

    Output bucket to use

    +

    Optional ReadonlysubDirectoryName

    subDirectoryName?: string

    Prefix for S3 object within bucket

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html index 53ce200..a8c92cf 100644 --- a/interfaces/SourceRepoProps.html +++ b/interfaces/SourceRepoProps.html @@ -1,4 +1,4 @@ -SourceRepoProps | aws4embeddedlinux-cdk-lib

    Interface SourceRepoProps

    interface SourceRepoProps {
        repoName: string;
        kind: ProjectKind;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • SourceRepoProps

    Properties

    repoName +SourceRepoProps | aws4embeddedlinux-cdk-lib

    Interface SourceRepoProps

    interface SourceRepoProps {
        repoName: string;
        kind: ProjectKind;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • SourceRepoProps

    Properties

    repoName kind description? env? @@ -12,8 +12,8 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlyrepoName

    repoName: string

    The name of the CodeCommit Repository created.

    -

    Readonlykind

    kind: ProjectKind

    The type of project to seed this repository with.

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Readonlykind

    kind: ProjectKind

    The type of project to seed this repository with.

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    From 82278afc417e14fbc263c629aa6a1fea58a60be0 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Wed, 22 Jan 2025 20:02:00 +0000 Subject: [PATCH 24/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@4371051f94d020a3f0169a607f?= =?UTF-8?q?1f983a43ea876f=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/BuildImageDataStack.html | 6 ++--- classes/BuildImagePipelineStack.html | 4 ++-- classes/BuildImageRepoStack.html | 6 ++--- .../EmbeddedLinuxCodebuildProjectStack.html | 4 ++-- classes/EmbeddedLinuxPipelineStack.html | 4 ++-- classes/PipelineNetworkStack.html | 6 ++--- classes/SourceRepo.html | 6 ++--- enums/ImageKind.html | 4 ++-- enums/ProjectKind.html | 16 ++++++------- interfaces/BuildImageDataProps.html | 4 ++-- interfaces/BuildImagePipelineProps.html | 14 +++++------ .../EmbeddedLinuxCodebuildProjectProps.html | 24 +++++++++---------- interfaces/EmbeddedLinuxPipelineProps.html | 24 +++++++++---------- interfaces/SourceRepoProps.html | 6 ++--- 14 files changed, 64 insertions(+), 64 deletions(-) diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html index 5497610..6c8c4e5 100644 --- a/classes/BuildImageDataStack.html +++ b/classes/BuildImageDataStack.html @@ -1,5 +1,5 @@ BuildImageDataStack | aws4embeddedlinux-cdk-lib

    Class BuildImageDataStack

    Input (Source) data for our BuildImagePipelineStack.

    -

    Hierarchy

    • Stack
      • BuildImageDataStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • BuildImageDataStack

    Constructors

    constructor

    Properties

    bucket tags templateOptions @@ -50,8 +50,8 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlybucket

    bucket: IBucket

    The bucket which will be consumed by the BuildImagePipelineStack.

    -

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlybucket

    bucket: IBucket

    The bucket which will be consumed by the BuildImagePipelineStack.

    +

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/BuildImagePipelineStack.html b/classes/BuildImagePipelineStack.html index cdb6e4c..51ace47 100644 --- a/classes/BuildImagePipelineStack.html +++ b/classes/BuildImagePipelineStack.html @@ -1,7 +1,7 @@ BuildImagePipelineStack | aws4embeddedlinux-cdk-lib

    Class BuildImagePipelineStack

    The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

    For configuration options see BuildImagePipelineProps.

    -

    Hierarchy

    • Stack
      • BuildImagePipelineStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • BuildImagePipelineStack

    Constructors

    constructor

    Properties

    tags templateOptions region @@ -51,7 +51,7 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html index 66825a8..ca0df0b 100644 --- a/classes/BuildImageRepoStack.html +++ b/classes/BuildImageRepoStack.html @@ -1,6 +1,6 @@ BuildImageRepoStack | aws4embeddedlinux-cdk-lib

    Class BuildImageRepoStack

    The ECR Repository to store build host images.

    This is the output of the BuildImagePipelineStack

    -

    Hierarchy

    • Stack
      • BuildImageRepoStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • BuildImageRepoStack

    Constructors

    constructor

    Properties

    repository tags templateOptions @@ -51,8 +51,8 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlyrepository

    repository: IRepository

    The respository to put the build host container in.

    -

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlyrepository

    repository: IRepository

    The respository to put the build host container in.

    +

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/EmbeddedLinuxCodebuildProjectStack.html b/classes/EmbeddedLinuxCodebuildProjectStack.html index b9a11b1..b392536 100644 --- a/classes/EmbeddedLinuxCodebuildProjectStack.html +++ b/classes/EmbeddedLinuxCodebuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodebuildProjectStack | aws4embeddedlinux-cdk-lib

    Class EmbeddedLinuxCodebuildProjectStack

    The stack for creating a build pipeline.

    See EmbeddedLinuxCodebuildProjectProps for configration options.

    -

    Hierarchy

    • Stack
      • EmbeddedLinuxCodebuildProjectStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • EmbeddedLinuxCodebuildProjectStack

    Constructors

    constructor

    Properties

    tags templateOptions region @@ -50,7 +50,7 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/EmbeddedLinuxPipelineStack.html b/classes/EmbeddedLinuxPipelineStack.html index 88f2c05..df1b296 100644 --- a/classes/EmbeddedLinuxPipelineStack.html +++ b/classes/EmbeddedLinuxPipelineStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxPipelineStack | aws4embeddedlinux-cdk-lib

    Class EmbeddedLinuxPipelineStack

    The stack for creating a build pipeline.

    See EmbeddedLinuxPipelineProps for configration options.

    -

    Hierarchy

    • Stack
      • EmbeddedLinuxPipelineStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • EmbeddedLinuxPipelineStack

    Constructors

    constructor

    Properties

    tags templateOptions region @@ -50,7 +50,7 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/PipelineNetworkStack.html b/classes/PipelineNetworkStack.html index 87a3288..7c0dcbb 100644 --- a/classes/PipelineNetworkStack.html +++ b/classes/PipelineNetworkStack.html @@ -1,7 +1,7 @@ PipelineNetworkStack | aws4embeddedlinux-cdk-lib

    Class PipelineNetworkStack

    The network resources to run the pipeline in.

    This stack is provided for when users do not have an existing VPC with private and public subnets for the pipeline.

    -

    Hierarchy

    • Stack
      • PipelineNetworkStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • PipelineNetworkStack

    Constructors

    constructor

    Properties

    vpc tags templateOptions @@ -52,8 +52,8 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlyvpc

    vpc: IVpc

    The VPC for the pipeline to reside in.

    -

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlyvpc

    vpc: IVpc

    The VPC for the pipeline to reside in.

    +

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html index 25cef66..ffe632b 100644 --- a/classes/SourceRepo.html +++ b/classes/SourceRepo.html @@ -1,13 +1,13 @@ SourceRepo | aws4embeddedlinux-cdk-lib

    Class SourceRepo

    The repository for the Source Stage of the pipeline.

    The initial contents of this repository are seeded by the assets contained in the source-repo/ folder of this library.

    -

    Hierarchy

    • Construct
      • SourceRepo

    Constructors

    constructor +

    Hierarchy

    • Construct
      • SourceRepo

    Constructors

    constructor

    Properties

    repo node

    Methods

    isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlyrepo

    repo: Repository

    The CodeCommit Repo itself.

    -

    Readonlynode

    node: Node

    The tree node.

    +

    Constructors

    constructor

    Properties

    Readonlyrepo

    repo: Repository

    The CodeCommit Repo itself.

    +

    Readonlynode

    node: Node

    The tree node.

    Methods

    StaticisConstruct

    • isConstruct(x: any): x is Construct

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      diff --git a/enums/ImageKind.html b/enums/ImageKind.html index fd8688c..205e8cc 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -1,4 +1,4 @@ ImageKind | aws4embeddedlinux-cdk-lib

      Enumeration ImageKind

      The type of Image to build on.

      -

      Enumeration Members

      Ubuntu22_04 +

      Enumeration Members

      Ubuntu22_04

      Enumeration Members

      Ubuntu22_04

      Ubuntu22_04: "ubuntu_22_04"

      Ubuntu 22.04 (LTS)

      -

      Settings

      Member Visibility

      On This Page

      Enumeration Members
      +

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html index 5a35903..e9bb84e 100644 --- a/enums/ProjectKind.html +++ b/enums/ProjectKind.html @@ -1,5 +1,5 @@ ProjectKind | aws4embeddedlinux-cdk-lib

    Enumeration ProjectKind

    The kind of project built.

    -

    Enumeration Members

    Poky +

    Enumeration Members

    Poky MetaAwsDemo PokyAmi Kas @@ -7,10 +7,10 @@ NxpImx CodeBuild

    Enumeration Members

    Poky

    Poky: "poky"

    Build core-image-minimal from poky.

    -

    MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"

    Build the Qemu meta-aws Demonstration Distribution.

    -

    PokyAmi

    PokyAmi: "poky-ami"

    Build an EC2 AMI

    -

    Kas

    Kas: "kas"

    Build an kas based image

    -

    Renesas

    Renesas: "renesas"

    Build an Renesas image

    -

    NxpImx

    NxpImx: "nxp-imx"

    Build an IMX image using NXP layers.

    -

    CodeBuild

    CodeBuild: "codebuild"

    Build no pipeline, just CodeBuild project to connect with GitHub actions.

    -

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"

    Build the Qemu meta-aws Demonstration Distribution.

    +

    PokyAmi

    PokyAmi: "poky-ami"

    Build an EC2 AMI

    +

    Kas

    Kas: "kas"

    Build an kas based image

    +

    Renesas

    Renesas: "renesas"

    Build an Renesas image

    +

    NxpImx

    NxpImx: "nxp-imx"

    Build an IMX image using NXP layers.

    +

    CodeBuild

    CodeBuild: "codebuild"

    Build no pipeline, just CodeBuild project to connect with GitHub actions.

    +

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html index 486fd88..aa053b1 100644 --- a/interfaces/BuildImageDataProps.html +++ b/interfaces/BuildImageDataProps.html @@ -1,5 +1,5 @@ BuildImageDataProps | aws4embeddedlinux-cdk-lib

    Interface BuildImageDataProps

    Select options for the BuildImageDataStack.

    -
    interface BuildImageDataProps {
        bucketName: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • BuildImageDataProps

    Properties

    bucketName +
    interface BuildImageDataProps {
        bucketName: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • BuildImageDataProps

    Properties

    bucketName description? env? stackName? @@ -12,7 +12,7 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlybucketName

    bucketName: string

    The bucket name for image build sources. This must be globally unique.

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    diff --git a/interfaces/BuildImagePipelineProps.html b/interfaces/BuildImagePipelineProps.html index 962d06e..21eb8b2 100644 --- a/interfaces/BuildImagePipelineProps.html +++ b/interfaces/BuildImagePipelineProps.html @@ -1,5 +1,5 @@ BuildImagePipelineProps | aws4embeddedlinux-cdk-lib

    Interface BuildImagePipelineProps

    Select options for the BuildImagePipelineStack.

    -
    interface BuildImagePipelineProps {
        imageKind: Ubuntu22_04;
        dataBucket: IBucket;
        repository: IRepository;
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • BuildImagePipelineProps

    Properties

    imageKind +
    interface BuildImagePipelineProps {
        imageKind: Ubuntu22_04;
        dataBucket: IBucket;
        repository: IRepository;
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • BuildImagePipelineProps

    Properties

    imageKind dataBucket repository accessLoggingBucket? @@ -17,12 +17,12 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlyimageKind

    imageKind: Ubuntu22_04

    The Image type to create.

    -

    ReadonlydataBucket

    dataBucket: IBucket

    The data bucket from the BuildImageDataStack

    -

    Readonlyrepository

    repository: IRepository

    The ECR Repository to push to.

    -

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    -

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    -

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    ReadonlydataBucket

    dataBucket: IBucket

    The data bucket from the BuildImageDataStack

    +

    Readonlyrepository

    repository: IRepository

    The ECR Repository to push to.

    +

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    +

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    +

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    diff --git a/interfaces/EmbeddedLinuxCodebuildProjectProps.html b/interfaces/EmbeddedLinuxCodebuildProjectProps.html index 2efaad8..f55499f 100644 --- a/interfaces/EmbeddedLinuxCodebuildProjectProps.html +++ b/interfaces/EmbeddedLinuxCodebuildProjectProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodebuildProjectProps | aws4embeddedlinux-cdk-lib

    Interface EmbeddedLinuxCodebuildProjectProps

    Properties to allow customizing the build.

    -
    interface EmbeddedLinuxCodebuildProjectProps {
        imageRepo: IRepository;
        imageTag?: string;
        vpc: IVpc;
        projectKind?: ProjectKind;
        layerRepoName?: string;
        buildPolicyAdditions?: PolicyStatement[];
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        outputBucket?: Bucket | VMImportBucket;
        subDirectoryName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxCodebuildProjectProps

    Properties

    imageRepo +
    interface EmbeddedLinuxCodebuildProjectProps {
        imageRepo: IRepository;
        imageTag?: string;
        vpc: IVpc;
        projectKind?: ProjectKind;
        layerRepoName?: string;
        buildPolicyAdditions?: PolicyStatement[];
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        outputBucket?: Bucket | VMImportBucket;
        subDirectoryName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxCodebuildProjectProps

    Properties

    imageRepo imageTag? vpc projectKind? @@ -22,17 +22,17 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlyimageRepo

    imageRepo: IRepository

    ECR Repository where the Build Host Image resides.

    -

    Optional ReadonlyimageTag

    imageTag?: string

    Tag for the Build Host Image

    -

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    -

    Optional ReadonlyprojectKind

    projectKind?: ProjectKind

    The type of project being built.

    -

    Optional ReadonlylayerRepoName

    layerRepoName?: string

    A name for the layer-repo that is created. Default is 'layer-repo'

    -

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    -

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    -

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    -

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    -

    Optional ReadonlyoutputBucket

    outputBucket?: Bucket | VMImportBucket

    Output bucket to use

    -

    Optional ReadonlysubDirectoryName

    subDirectoryName?: string

    Prefix for S3 object within bucket

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Optional ReadonlyimageTag

    imageTag?: string

    Tag for the Build Host Image

    +

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    +

    Optional ReadonlyprojectKind

    projectKind?: ProjectKind

    The type of project being built.

    +

    Optional ReadonlylayerRepoName

    layerRepoName?: string

    A name for the layer-repo that is created. Default is 'layer-repo'

    +

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    +

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    +

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    +

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    +

    Optional ReadonlyoutputBucket

    outputBucket?: Bucket | VMImportBucket

    Output bucket to use

    +

    Optional ReadonlysubDirectoryName

    subDirectoryName?: string

    Prefix for S3 object within bucket

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    diff --git a/interfaces/EmbeddedLinuxPipelineProps.html b/interfaces/EmbeddedLinuxPipelineProps.html index 5865d6f..c92e1c6 100644 --- a/interfaces/EmbeddedLinuxPipelineProps.html +++ b/interfaces/EmbeddedLinuxPipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxPipelineProps | aws4embeddedlinux-cdk-lib

    Interface EmbeddedLinuxPipelineProps

    Properties to allow customizing the build.

    -
    interface EmbeddedLinuxPipelineProps {
        imageRepo: IRepository;
        imageTag?: string;
        vpc: IVpc;
        projectKind?: ProjectKind;
        layerRepoName?: string;
        buildPolicyAdditions?: PolicyStatement[];
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        outputBucket?: Bucket | VMImportBucket;
        subDirectoryName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxPipelineProps

    Properties

    imageRepo +
    interface EmbeddedLinuxPipelineProps {
        imageRepo: IRepository;
        imageTag?: string;
        vpc: IVpc;
        projectKind?: ProjectKind;
        layerRepoName?: string;
        buildPolicyAdditions?: PolicyStatement[];
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        outputBucket?: Bucket | VMImportBucket;
        subDirectoryName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxPipelineProps

    Properties

    imageRepo imageTag? vpc projectKind? @@ -22,17 +22,17 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlyimageRepo

    imageRepo: IRepository

    ECR Repository where the Build Host Image resides.

    -

    Optional ReadonlyimageTag

    imageTag?: string

    Tag for the Build Host Image

    -

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    -

    Optional ReadonlyprojectKind

    projectKind?: ProjectKind

    The type of project being built.

    -

    Optional ReadonlylayerRepoName

    layerRepoName?: string

    A name for the layer-repo that is created. Default is 'layer-repo'

    -

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    -

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    -

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    -

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    -

    Optional ReadonlyoutputBucket

    outputBucket?: Bucket | VMImportBucket

    Output bucket to use

    -

    Optional ReadonlysubDirectoryName

    subDirectoryName?: string

    Prefix for S3 object within bucket

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Optional ReadonlyimageTag

    imageTag?: string

    Tag for the Build Host Image

    +

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    +

    Optional ReadonlyprojectKind

    projectKind?: ProjectKind

    The type of project being built.

    +

    Optional ReadonlylayerRepoName

    layerRepoName?: string

    A name for the layer-repo that is created. Default is 'layer-repo'

    +

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    +

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    +

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    +

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    +

    Optional ReadonlyoutputBucket

    outputBucket?: Bucket | VMImportBucket

    Output bucket to use

    +

    Optional ReadonlysubDirectoryName

    subDirectoryName?: string

    Prefix for S3 object within bucket

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html index a8c92cf..2667d5a 100644 --- a/interfaces/SourceRepoProps.html +++ b/interfaces/SourceRepoProps.html @@ -1,4 +1,4 @@ -SourceRepoProps | aws4embeddedlinux-cdk-lib

    Interface SourceRepoProps

    interface SourceRepoProps {
        repoName: string;
        kind: ProjectKind;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • SourceRepoProps

    Properties

    repoName +SourceRepoProps | aws4embeddedlinux-cdk-lib

    Interface SourceRepoProps

    interface SourceRepoProps {
        repoName: string;
        kind: ProjectKind;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • SourceRepoProps

    Properties

    repoName kind description? env? @@ -12,8 +12,8 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlyrepoName

    repoName: string

    The name of the CodeCommit Repository created.

    -

    Readonlykind

    kind: ProjectKind

    The type of project to seed this repository with.

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Readonlykind

    kind: ProjectKind

    The type of project to seed this repository with.

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    From 0f1f5eb7bc62fef4857bf017a5406764404acfe9 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Wed, 22 Jan 2025 20:05:41 +0000 Subject: [PATCH 25/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@f0ddfc4a1d5c218cf13659249c?= =?UTF-8?q?7f43ed94289815=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/BuildImageDataStack.html | 6 ++--- classes/BuildImagePipelineStack.html | 4 ++-- classes/BuildImageRepoStack.html | 6 ++--- .../EmbeddedLinuxCodebuildProjectStack.html | 4 ++-- classes/EmbeddedLinuxPipelineStack.html | 4 ++-- classes/PipelineNetworkStack.html | 6 ++--- classes/SourceRepo.html | 6 ++--- enums/ImageKind.html | 4 ++-- enums/ProjectKind.html | 16 ++++++------- index.html | 2 +- interfaces/BuildImageDataProps.html | 4 ++-- interfaces/BuildImagePipelineProps.html | 14 +++++------ .../EmbeddedLinuxCodebuildProjectProps.html | 24 +++++++++---------- interfaces/EmbeddedLinuxPipelineProps.html | 24 +++++++++---------- interfaces/SourceRepoProps.html | 6 ++--- 15 files changed, 65 insertions(+), 65 deletions(-) diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html index 6c8c4e5..5f41168 100644 --- a/classes/BuildImageDataStack.html +++ b/classes/BuildImageDataStack.html @@ -1,5 +1,5 @@ BuildImageDataStack | aws4embeddedlinux-cdk-lib

    Class BuildImageDataStack

    Input (Source) data for our BuildImagePipelineStack.

    -

    Hierarchy

    • Stack
      • BuildImageDataStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • BuildImageDataStack

    Constructors

    constructor

    Properties

    bucket tags templateOptions @@ -50,8 +50,8 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlybucket

    bucket: IBucket

    The bucket which will be consumed by the BuildImagePipelineStack.

    -

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlybucket

    bucket: IBucket

    The bucket which will be consumed by the BuildImagePipelineStack.

    +

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/BuildImagePipelineStack.html b/classes/BuildImagePipelineStack.html index 51ace47..df1d665 100644 --- a/classes/BuildImagePipelineStack.html +++ b/classes/BuildImagePipelineStack.html @@ -1,7 +1,7 @@ BuildImagePipelineStack | aws4embeddedlinux-cdk-lib

    Class BuildImagePipelineStack

    The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

    For configuration options see BuildImagePipelineProps.

    -

    Hierarchy

    • Stack
      • BuildImagePipelineStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • BuildImagePipelineStack

    Constructors

    constructor

    Properties

    tags templateOptions region @@ -51,7 +51,7 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html index ca0df0b..d4053fb 100644 --- a/classes/BuildImageRepoStack.html +++ b/classes/BuildImageRepoStack.html @@ -1,6 +1,6 @@ BuildImageRepoStack | aws4embeddedlinux-cdk-lib

    Class BuildImageRepoStack

    The ECR Repository to store build host images.

    This is the output of the BuildImagePipelineStack

    -

    Hierarchy

    • Stack
      • BuildImageRepoStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • BuildImageRepoStack

    Constructors

    constructor

    Properties

    repository tags templateOptions @@ -51,8 +51,8 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlyrepository

    repository: IRepository

    The respository to put the build host container in.

    -

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlyrepository

    repository: IRepository

    The respository to put the build host container in.

    +

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/EmbeddedLinuxCodebuildProjectStack.html b/classes/EmbeddedLinuxCodebuildProjectStack.html index b392536..63b5f8c 100644 --- a/classes/EmbeddedLinuxCodebuildProjectStack.html +++ b/classes/EmbeddedLinuxCodebuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodebuildProjectStack | aws4embeddedlinux-cdk-lib

    Class EmbeddedLinuxCodebuildProjectStack

    The stack for creating a build pipeline.

    See EmbeddedLinuxCodebuildProjectProps for configration options.

    -

    Hierarchy

    • Stack
      • EmbeddedLinuxCodebuildProjectStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • EmbeddedLinuxCodebuildProjectStack

    Constructors

    constructor

    Properties

    tags templateOptions region @@ -50,7 +50,7 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/EmbeddedLinuxPipelineStack.html b/classes/EmbeddedLinuxPipelineStack.html index df1b296..681747e 100644 --- a/classes/EmbeddedLinuxPipelineStack.html +++ b/classes/EmbeddedLinuxPipelineStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxPipelineStack | aws4embeddedlinux-cdk-lib

    Class EmbeddedLinuxPipelineStack

    The stack for creating a build pipeline.

    See EmbeddedLinuxPipelineProps for configration options.

    -

    Hierarchy

    • Stack
      • EmbeddedLinuxPipelineStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • EmbeddedLinuxPipelineStack

    Constructors

    constructor

    Properties

    tags templateOptions region @@ -50,7 +50,7 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/PipelineNetworkStack.html b/classes/PipelineNetworkStack.html index 7c0dcbb..f602d6a 100644 --- a/classes/PipelineNetworkStack.html +++ b/classes/PipelineNetworkStack.html @@ -1,7 +1,7 @@ PipelineNetworkStack | aws4embeddedlinux-cdk-lib

    Class PipelineNetworkStack

    The network resources to run the pipeline in.

    This stack is provided for when users do not have an existing VPC with private and public subnets for the pipeline.

    -

    Hierarchy

    • Stack
      • PipelineNetworkStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • PipelineNetworkStack

    Constructors

    constructor

    Properties

    vpc tags templateOptions @@ -52,8 +52,8 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlyvpc

    vpc: IVpc

    The VPC for the pipeline to reside in.

    -

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlyvpc

    vpc: IVpc

    The VPC for the pipeline to reside in.

    +

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html index ffe632b..7a570c9 100644 --- a/classes/SourceRepo.html +++ b/classes/SourceRepo.html @@ -1,13 +1,13 @@ SourceRepo | aws4embeddedlinux-cdk-lib

    Class SourceRepo

    The repository for the Source Stage of the pipeline.

    The initial contents of this repository are seeded by the assets contained in the source-repo/ folder of this library.

    -

    Hierarchy

    • Construct
      • SourceRepo

    Constructors

    constructor +

    Hierarchy

    • Construct
      • SourceRepo

    Constructors

    constructor

    Properties

    repo node

    Methods

    isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlyrepo

    repo: Repository

    The CodeCommit Repo itself.

    -

    Readonlynode

    node: Node

    The tree node.

    +

    Constructors

    constructor

    Properties

    Readonlyrepo

    repo: Repository

    The CodeCommit Repo itself.

    +

    Readonlynode

    node: Node

    The tree node.

    Methods

    StaticisConstruct

    • isConstruct(x: any): x is Construct

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      diff --git a/enums/ImageKind.html b/enums/ImageKind.html index 205e8cc..214f3e4 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -1,4 +1,4 @@ ImageKind | aws4embeddedlinux-cdk-lib

      Enumeration ImageKind

      The type of Image to build on.

      -

      Enumeration Members

      Ubuntu22_04 +

      Enumeration Members

      Ubuntu22_04

      Enumeration Members

      Ubuntu22_04

      Ubuntu22_04: "ubuntu_22_04"

      Ubuntu 22.04 (LTS)

      -

      Settings

      Member Visibility

      On This Page

      Enumeration Members
      +

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html index e9bb84e..05fd0e2 100644 --- a/enums/ProjectKind.html +++ b/enums/ProjectKind.html @@ -1,5 +1,5 @@ ProjectKind | aws4embeddedlinux-cdk-lib

    Enumeration ProjectKind

    The kind of project built.

    -

    Enumeration Members

    Poky +

    Enumeration Members

    Poky MetaAwsDemo PokyAmi Kas @@ -7,10 +7,10 @@ NxpImx CodeBuild

    Enumeration Members

    Poky

    Poky: "poky"

    Build core-image-minimal from poky.

    -

    MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"

    Build the Qemu meta-aws Demonstration Distribution.

    -

    PokyAmi

    PokyAmi: "poky-ami"

    Build an EC2 AMI

    -

    Kas

    Kas: "kas"

    Build an kas based image

    -

    Renesas

    Renesas: "renesas"

    Build an Renesas image

    -

    NxpImx

    NxpImx: "nxp-imx"

    Build an IMX image using NXP layers.

    -

    CodeBuild

    CodeBuild: "codebuild"

    Build no pipeline, just CodeBuild project to connect with GitHub actions.

    -

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"

    Build the Qemu meta-aws Demonstration Distribution.

    +

    PokyAmi

    PokyAmi: "poky-ami"

    Build an EC2 AMI

    +

    Kas

    Kas: "kas"

    Build an kas based image

    +

    Renesas

    Renesas: "renesas"

    Build an Renesas image

    +

    NxpImx

    NxpImx: "nxp-imx"

    Build an IMX image using NXP layers.

    +

    CodeBuild

    CodeBuild: "codebuild"

    Build no pipeline, just CodeBuild project to connect with GitHub actions.

    +

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/index.html b/index.html index 47ef0f2..96fd5d7 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@

    Setting Up

    In order to use this library, you must set up the CDK, including installing the CDK tool and bootstrapping the account you wish to deploy to. Additionally, you must have Node installed.

    Note

    -This library is tested against Node Versions 16, 18, and 20. If these versions are not available for your system, we recommend +This library is tested against Node Versions 22. If these version is not available for your system, we recommend using NVM to install a compatible version

    Quickstart

    Use the examples in our examples repo.

    diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html index aa053b1..5b73a5a 100644 --- a/interfaces/BuildImageDataProps.html +++ b/interfaces/BuildImageDataProps.html @@ -1,5 +1,5 @@ BuildImageDataProps | aws4embeddedlinux-cdk-lib

    Interface BuildImageDataProps

    Select options for the BuildImageDataStack.

    -
    interface BuildImageDataProps {
        bucketName: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • BuildImageDataProps

    Properties

    bucketName +
    interface BuildImageDataProps {
        bucketName: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • BuildImageDataProps

    Properties

    bucketName description? env? stackName? @@ -12,7 +12,7 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlybucketName

    bucketName: string

    The bucket name for image build sources. This must be globally unique.

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    diff --git a/interfaces/BuildImagePipelineProps.html b/interfaces/BuildImagePipelineProps.html index 21eb8b2..1b02dd6 100644 --- a/interfaces/BuildImagePipelineProps.html +++ b/interfaces/BuildImagePipelineProps.html @@ -1,5 +1,5 @@ BuildImagePipelineProps | aws4embeddedlinux-cdk-lib

    Interface BuildImagePipelineProps

    Select options for the BuildImagePipelineStack.

    -
    interface BuildImagePipelineProps {
        imageKind: Ubuntu22_04;
        dataBucket: IBucket;
        repository: IRepository;
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • BuildImagePipelineProps

    Properties

    imageKind +
    interface BuildImagePipelineProps {
        imageKind: Ubuntu22_04;
        dataBucket: IBucket;
        repository: IRepository;
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • BuildImagePipelineProps

    Properties

    imageKind dataBucket repository accessLoggingBucket? @@ -17,12 +17,12 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlyimageKind

    imageKind: Ubuntu22_04

    The Image type to create.

    -

    ReadonlydataBucket

    dataBucket: IBucket

    The data bucket from the BuildImageDataStack

    -

    Readonlyrepository

    repository: IRepository

    The ECR Repository to push to.

    -

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    -

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    -

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    ReadonlydataBucket

    dataBucket: IBucket

    The data bucket from the BuildImageDataStack

    +

    Readonlyrepository

    repository: IRepository

    The ECR Repository to push to.

    +

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    +

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    +

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    diff --git a/interfaces/EmbeddedLinuxCodebuildProjectProps.html b/interfaces/EmbeddedLinuxCodebuildProjectProps.html index f55499f..fe984fc 100644 --- a/interfaces/EmbeddedLinuxCodebuildProjectProps.html +++ b/interfaces/EmbeddedLinuxCodebuildProjectProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodebuildProjectProps | aws4embeddedlinux-cdk-lib

    Interface EmbeddedLinuxCodebuildProjectProps

    Properties to allow customizing the build.

    -
    interface EmbeddedLinuxCodebuildProjectProps {
        imageRepo: IRepository;
        imageTag?: string;
        vpc: IVpc;
        projectKind?: ProjectKind;
        layerRepoName?: string;
        buildPolicyAdditions?: PolicyStatement[];
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        outputBucket?: Bucket | VMImportBucket;
        subDirectoryName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxCodebuildProjectProps

    Properties

    imageRepo +
    interface EmbeddedLinuxCodebuildProjectProps {
        imageRepo: IRepository;
        imageTag?: string;
        vpc: IVpc;
        projectKind?: ProjectKind;
        layerRepoName?: string;
        buildPolicyAdditions?: PolicyStatement[];
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        outputBucket?: Bucket | VMImportBucket;
        subDirectoryName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxCodebuildProjectProps

    Properties

    imageRepo imageTag? vpc projectKind? @@ -22,17 +22,17 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlyimageRepo

    imageRepo: IRepository

    ECR Repository where the Build Host Image resides.

    -

    Optional ReadonlyimageTag

    imageTag?: string

    Tag for the Build Host Image

    -

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    -

    Optional ReadonlyprojectKind

    projectKind?: ProjectKind

    The type of project being built.

    -

    Optional ReadonlylayerRepoName

    layerRepoName?: string

    A name for the layer-repo that is created. Default is 'layer-repo'

    -

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    -

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    -

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    -

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    -

    Optional ReadonlyoutputBucket

    outputBucket?: Bucket | VMImportBucket

    Output bucket to use

    -

    Optional ReadonlysubDirectoryName

    subDirectoryName?: string

    Prefix for S3 object within bucket

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Optional ReadonlyimageTag

    imageTag?: string

    Tag for the Build Host Image

    +

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    +

    Optional ReadonlyprojectKind

    projectKind?: ProjectKind

    The type of project being built.

    +

    Optional ReadonlylayerRepoName

    layerRepoName?: string

    A name for the layer-repo that is created. Default is 'layer-repo'

    +

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    +

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    +

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    +

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    +

    Optional ReadonlyoutputBucket

    outputBucket?: Bucket | VMImportBucket

    Output bucket to use

    +

    Optional ReadonlysubDirectoryName

    subDirectoryName?: string

    Prefix for S3 object within bucket

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    diff --git a/interfaces/EmbeddedLinuxPipelineProps.html b/interfaces/EmbeddedLinuxPipelineProps.html index c92e1c6..d103b16 100644 --- a/interfaces/EmbeddedLinuxPipelineProps.html +++ b/interfaces/EmbeddedLinuxPipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxPipelineProps | aws4embeddedlinux-cdk-lib

    Interface EmbeddedLinuxPipelineProps

    Properties to allow customizing the build.

    -
    interface EmbeddedLinuxPipelineProps {
        imageRepo: IRepository;
        imageTag?: string;
        vpc: IVpc;
        projectKind?: ProjectKind;
        layerRepoName?: string;
        buildPolicyAdditions?: PolicyStatement[];
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        outputBucket?: Bucket | VMImportBucket;
        subDirectoryName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxPipelineProps

    Properties

    imageRepo +
    interface EmbeddedLinuxPipelineProps {
        imageRepo: IRepository;
        imageTag?: string;
        vpc: IVpc;
        projectKind?: ProjectKind;
        layerRepoName?: string;
        buildPolicyAdditions?: PolicyStatement[];
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        outputBucket?: Bucket | VMImportBucket;
        subDirectoryName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxPipelineProps

    Properties

    imageRepo imageTag? vpc projectKind? @@ -22,17 +22,17 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlyimageRepo

    imageRepo: IRepository

    ECR Repository where the Build Host Image resides.

    -

    Optional ReadonlyimageTag

    imageTag?: string

    Tag for the Build Host Image

    -

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    -

    Optional ReadonlyprojectKind

    projectKind?: ProjectKind

    The type of project being built.

    -

    Optional ReadonlylayerRepoName

    layerRepoName?: string

    A name for the layer-repo that is created. Default is 'layer-repo'

    -

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    -

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    -

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    -

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    -

    Optional ReadonlyoutputBucket

    outputBucket?: Bucket | VMImportBucket

    Output bucket to use

    -

    Optional ReadonlysubDirectoryName

    subDirectoryName?: string

    Prefix for S3 object within bucket

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Optional ReadonlyimageTag

    imageTag?: string

    Tag for the Build Host Image

    +

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    +

    Optional ReadonlyprojectKind

    projectKind?: ProjectKind

    The type of project being built.

    +

    Optional ReadonlylayerRepoName

    layerRepoName?: string

    A name for the layer-repo that is created. Default is 'layer-repo'

    +

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    +

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    +

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    +

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    +

    Optional ReadonlyoutputBucket

    outputBucket?: Bucket | VMImportBucket

    Output bucket to use

    +

    Optional ReadonlysubDirectoryName

    subDirectoryName?: string

    Prefix for S3 object within bucket

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html index 2667d5a..1fb7ada 100644 --- a/interfaces/SourceRepoProps.html +++ b/interfaces/SourceRepoProps.html @@ -1,4 +1,4 @@ -SourceRepoProps | aws4embeddedlinux-cdk-lib

    Interface SourceRepoProps

    interface SourceRepoProps {
        repoName: string;
        kind: ProjectKind;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • SourceRepoProps

    Properties

    repoName +SourceRepoProps | aws4embeddedlinux-cdk-lib

    Interface SourceRepoProps

    interface SourceRepoProps {
        repoName: string;
        kind: ProjectKind;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • SourceRepoProps

    Properties

    repoName kind description? env? @@ -12,8 +12,8 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlyrepoName

    repoName: string

    The name of the CodeCommit Repository created.

    -

    Readonlykind

    kind: ProjectKind

    The type of project to seed this repository with.

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Readonlykind

    kind: ProjectKind

    The type of project to seed this repository with.

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    From 206c17133b80ee5538c9bf6ce8d27325f96c0d7f Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 24 Feb 2025 12:58:43 +0000 Subject: [PATCH 26/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@0e8e4cd6809a0d23108ce8f6b2?= =?UTF-8?q?d7772d37e4774b=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/BuildImageDataStack.html | 6 ++--- classes/BuildImagePipelineStack.html | 4 ++-- classes/BuildImageRepoStack.html | 6 ++--- .../EmbeddedLinuxCodebuildProjectStack.html | 4 ++-- classes/EmbeddedLinuxPipelineStack.html | 4 ++-- classes/PipelineNetworkStack.html | 6 ++--- classes/SourceRepo.html | 6 ++--- enums/ImageKind.html | 4 ++-- enums/ProjectKind.html | 16 ++++++------- interfaces/BuildImageDataProps.html | 4 ++-- interfaces/BuildImagePipelineProps.html | 14 +++++------ .../EmbeddedLinuxCodebuildProjectProps.html | 24 +++++++++---------- interfaces/EmbeddedLinuxPipelineProps.html | 24 +++++++++---------- interfaces/SourceRepoProps.html | 6 ++--- 14 files changed, 64 insertions(+), 64 deletions(-) diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html index 5f41168..366adce 100644 --- a/classes/BuildImageDataStack.html +++ b/classes/BuildImageDataStack.html @@ -1,5 +1,5 @@ BuildImageDataStack | aws4embeddedlinux-cdk-lib

    Class BuildImageDataStack

    Input (Source) data for our BuildImagePipelineStack.

    -

    Hierarchy

    • Stack
      • BuildImageDataStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • BuildImageDataStack

    Constructors

    constructor

    Properties

    bucket tags templateOptions @@ -50,8 +50,8 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlybucket

    bucket: IBucket

    The bucket which will be consumed by the BuildImagePipelineStack.

    -

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlybucket

    bucket: IBucket

    The bucket which will be consumed by the BuildImagePipelineStack.

    +

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/BuildImagePipelineStack.html b/classes/BuildImagePipelineStack.html index df1d665..c1c38da 100644 --- a/classes/BuildImagePipelineStack.html +++ b/classes/BuildImagePipelineStack.html @@ -1,7 +1,7 @@ BuildImagePipelineStack | aws4embeddedlinux-cdk-lib

    Class BuildImagePipelineStack

    The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

    For configuration options see BuildImagePipelineProps.

    -

    Hierarchy

    • Stack
      • BuildImagePipelineStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • BuildImagePipelineStack

    Constructors

    constructor

    Properties

    tags templateOptions region @@ -51,7 +51,7 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html index d4053fb..f8a84d5 100644 --- a/classes/BuildImageRepoStack.html +++ b/classes/BuildImageRepoStack.html @@ -1,6 +1,6 @@ BuildImageRepoStack | aws4embeddedlinux-cdk-lib

    Class BuildImageRepoStack

    The ECR Repository to store build host images.

    This is the output of the BuildImagePipelineStack

    -

    Hierarchy

    • Stack
      • BuildImageRepoStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • BuildImageRepoStack

    Constructors

    constructor

    Properties

    repository tags templateOptions @@ -51,8 +51,8 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlyrepository

    repository: IRepository

    The respository to put the build host container in.

    -

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlyrepository

    repository: IRepository

    The respository to put the build host container in.

    +

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/EmbeddedLinuxCodebuildProjectStack.html b/classes/EmbeddedLinuxCodebuildProjectStack.html index 63b5f8c..7706094 100644 --- a/classes/EmbeddedLinuxCodebuildProjectStack.html +++ b/classes/EmbeddedLinuxCodebuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodebuildProjectStack | aws4embeddedlinux-cdk-lib

    Class EmbeddedLinuxCodebuildProjectStack

    The stack for creating a build pipeline.

    See EmbeddedLinuxCodebuildProjectProps for configration options.

    -

    Hierarchy

    • Stack
      • EmbeddedLinuxCodebuildProjectStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • EmbeddedLinuxCodebuildProjectStack

    Constructors

    constructor

    Properties

    tags templateOptions region @@ -50,7 +50,7 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/EmbeddedLinuxPipelineStack.html b/classes/EmbeddedLinuxPipelineStack.html index 681747e..bcf1b69 100644 --- a/classes/EmbeddedLinuxPipelineStack.html +++ b/classes/EmbeddedLinuxPipelineStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxPipelineStack | aws4embeddedlinux-cdk-lib

    Class EmbeddedLinuxPipelineStack

    The stack for creating a build pipeline.

    See EmbeddedLinuxPipelineProps for configration options.

    -

    Hierarchy

    • Stack
      • EmbeddedLinuxPipelineStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • EmbeddedLinuxPipelineStack

    Constructors

    constructor

    Properties

    tags templateOptions region @@ -50,7 +50,7 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/PipelineNetworkStack.html b/classes/PipelineNetworkStack.html index f602d6a..0e816f9 100644 --- a/classes/PipelineNetworkStack.html +++ b/classes/PipelineNetworkStack.html @@ -1,7 +1,7 @@ PipelineNetworkStack | aws4embeddedlinux-cdk-lib

    Class PipelineNetworkStack

    The network resources to run the pipeline in.

    This stack is provided for when users do not have an existing VPC with private and public subnets for the pipeline.

    -

    Hierarchy

    • Stack
      • PipelineNetworkStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • PipelineNetworkStack

    Constructors

    constructor

    Properties

    vpc tags templateOptions @@ -52,8 +52,8 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlyvpc

    vpc: IVpc

    The VPC for the pipeline to reside in.

    -

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlyvpc

    vpc: IVpc

    The VPC for the pipeline to reside in.

    +

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html index 7a570c9..1544352 100644 --- a/classes/SourceRepo.html +++ b/classes/SourceRepo.html @@ -1,13 +1,13 @@ SourceRepo | aws4embeddedlinux-cdk-lib

    Class SourceRepo

    The repository for the Source Stage of the pipeline.

    The initial contents of this repository are seeded by the assets contained in the source-repo/ folder of this library.

    -

    Hierarchy

    • Construct
      • SourceRepo

    Constructors

    constructor +

    Hierarchy

    • Construct
      • SourceRepo

    Constructors

    constructor

    Properties

    repo node

    Methods

    isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlyrepo

    repo: Repository

    The CodeCommit Repo itself.

    -

    Readonlynode

    node: Node

    The tree node.

    +

    Constructors

    constructor

    Properties

    Readonlyrepo

    repo: Repository

    The CodeCommit Repo itself.

    +

    Readonlynode

    node: Node

    The tree node.

    Methods

    StaticisConstruct

    • isConstruct(x: any): x is Construct

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      diff --git a/enums/ImageKind.html b/enums/ImageKind.html index 214f3e4..36114c4 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -1,4 +1,4 @@ ImageKind | aws4embeddedlinux-cdk-lib

      Enumeration ImageKind

      The type of Image to build on.

      -

      Enumeration Members

      Ubuntu22_04 +

      Enumeration Members

      Ubuntu22_04

      Enumeration Members

      Ubuntu22_04

      Ubuntu22_04: "ubuntu_22_04"

      Ubuntu 22.04 (LTS)

      -

      Settings

      Member Visibility

      On This Page

      Enumeration Members
      +

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html index 05fd0e2..1f888cd 100644 --- a/enums/ProjectKind.html +++ b/enums/ProjectKind.html @@ -1,5 +1,5 @@ ProjectKind | aws4embeddedlinux-cdk-lib

    Enumeration ProjectKind

    The kind of project built.

    -

    Enumeration Members

    Poky +

    Enumeration Members

    Poky MetaAwsDemo PokyAmi Kas @@ -7,10 +7,10 @@ NxpImx CodeBuild

    Enumeration Members

    Poky

    Poky: "poky"

    Build core-image-minimal from poky.

    -

    MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"

    Build the Qemu meta-aws Demonstration Distribution.

    -

    PokyAmi

    PokyAmi: "poky-ami"

    Build an EC2 AMI

    -

    Kas

    Kas: "kas"

    Build an kas based image

    -

    Renesas

    Renesas: "renesas"

    Build an Renesas image

    -

    NxpImx

    NxpImx: "nxp-imx"

    Build an IMX image using NXP layers.

    -

    CodeBuild

    CodeBuild: "codebuild"

    Build no pipeline, just CodeBuild project to connect with GitHub actions.

    -

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"

    Build the Qemu meta-aws Demonstration Distribution.

    +

    PokyAmi

    PokyAmi: "poky-ami"

    Build an EC2 AMI

    +

    Kas

    Kas: "kas"

    Build an kas based image

    +

    Renesas

    Renesas: "renesas"

    Build an Renesas image

    +

    NxpImx

    NxpImx: "nxp-imx"

    Build an IMX image using NXP layers.

    +

    CodeBuild

    CodeBuild: "codebuild"

    Build no pipeline, just CodeBuild project to connect with GitHub actions.

    +

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html index 5b73a5a..6d20c52 100644 --- a/interfaces/BuildImageDataProps.html +++ b/interfaces/BuildImageDataProps.html @@ -1,5 +1,5 @@ BuildImageDataProps | aws4embeddedlinux-cdk-lib

    Interface BuildImageDataProps

    Select options for the BuildImageDataStack.

    -
    interface BuildImageDataProps {
        bucketName: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • BuildImageDataProps

    Properties

    bucketName +
    interface BuildImageDataProps {
        bucketName: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • BuildImageDataProps

    Properties

    bucketName description? env? stackName? @@ -12,7 +12,7 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlybucketName

    bucketName: string

    The bucket name for image build sources. This must be globally unique.

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    diff --git a/interfaces/BuildImagePipelineProps.html b/interfaces/BuildImagePipelineProps.html index 1b02dd6..d679b54 100644 --- a/interfaces/BuildImagePipelineProps.html +++ b/interfaces/BuildImagePipelineProps.html @@ -1,5 +1,5 @@ BuildImagePipelineProps | aws4embeddedlinux-cdk-lib

    Interface BuildImagePipelineProps

    Select options for the BuildImagePipelineStack.

    -
    interface BuildImagePipelineProps {
        imageKind: Ubuntu22_04;
        dataBucket: IBucket;
        repository: IRepository;
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • BuildImagePipelineProps

    Properties

    imageKind +
    interface BuildImagePipelineProps {
        imageKind: Ubuntu22_04;
        dataBucket: IBucket;
        repository: IRepository;
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • BuildImagePipelineProps

    Properties

    imageKind dataBucket repository accessLoggingBucket? @@ -17,12 +17,12 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlyimageKind

    imageKind: Ubuntu22_04

    The Image type to create.

    -

    ReadonlydataBucket

    dataBucket: IBucket

    The data bucket from the BuildImageDataStack

    -

    Readonlyrepository

    repository: IRepository

    The ECR Repository to push to.

    -

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    -

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    -

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    ReadonlydataBucket

    dataBucket: IBucket

    The data bucket from the BuildImageDataStack

    +

    Readonlyrepository

    repository: IRepository

    The ECR Repository to push to.

    +

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    +

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    +

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    diff --git a/interfaces/EmbeddedLinuxCodebuildProjectProps.html b/interfaces/EmbeddedLinuxCodebuildProjectProps.html index fe984fc..388b3ce 100644 --- a/interfaces/EmbeddedLinuxCodebuildProjectProps.html +++ b/interfaces/EmbeddedLinuxCodebuildProjectProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodebuildProjectProps | aws4embeddedlinux-cdk-lib

    Interface EmbeddedLinuxCodebuildProjectProps

    Properties to allow customizing the build.

    -
    interface EmbeddedLinuxCodebuildProjectProps {
        imageRepo: IRepository;
        imageTag?: string;
        vpc: IVpc;
        projectKind?: ProjectKind;
        layerRepoName?: string;
        buildPolicyAdditions?: PolicyStatement[];
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        outputBucket?: Bucket | VMImportBucket;
        subDirectoryName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxCodebuildProjectProps

    Properties

    imageRepo +
    interface EmbeddedLinuxCodebuildProjectProps {
        imageRepo: IRepository;
        imageTag?: string;
        vpc: IVpc;
        projectKind?: ProjectKind;
        layerRepoName?: string;
        buildPolicyAdditions?: PolicyStatement[];
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        outputBucket?: Bucket | VMImportBucket;
        subDirectoryName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxCodebuildProjectProps

    Properties

    imageRepo imageTag? vpc projectKind? @@ -22,17 +22,17 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlyimageRepo

    imageRepo: IRepository

    ECR Repository where the Build Host Image resides.

    -

    Optional ReadonlyimageTag

    imageTag?: string

    Tag for the Build Host Image

    -

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    -

    Optional ReadonlyprojectKind

    projectKind?: ProjectKind

    The type of project being built.

    -

    Optional ReadonlylayerRepoName

    layerRepoName?: string

    A name for the layer-repo that is created. Default is 'layer-repo'

    -

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    -

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    -

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    -

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    -

    Optional ReadonlyoutputBucket

    outputBucket?: Bucket | VMImportBucket

    Output bucket to use

    -

    Optional ReadonlysubDirectoryName

    subDirectoryName?: string

    Prefix for S3 object within bucket

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Optional ReadonlyimageTag

    imageTag?: string

    Tag for the Build Host Image

    +

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    +

    Optional ReadonlyprojectKind

    projectKind?: ProjectKind

    The type of project being built.

    +

    Optional ReadonlylayerRepoName

    layerRepoName?: string

    A name for the layer-repo that is created. Default is 'layer-repo'

    +

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    +

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    +

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    +

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    +

    Optional ReadonlyoutputBucket

    outputBucket?: Bucket | VMImportBucket

    Output bucket to use

    +

    Optional ReadonlysubDirectoryName

    subDirectoryName?: string

    Prefix for S3 object within bucket

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    diff --git a/interfaces/EmbeddedLinuxPipelineProps.html b/interfaces/EmbeddedLinuxPipelineProps.html index d103b16..29e67cd 100644 --- a/interfaces/EmbeddedLinuxPipelineProps.html +++ b/interfaces/EmbeddedLinuxPipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxPipelineProps | aws4embeddedlinux-cdk-lib

    Interface EmbeddedLinuxPipelineProps

    Properties to allow customizing the build.

    -
    interface EmbeddedLinuxPipelineProps {
        imageRepo: IRepository;
        imageTag?: string;
        vpc: IVpc;
        projectKind?: ProjectKind;
        layerRepoName?: string;
        buildPolicyAdditions?: PolicyStatement[];
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        outputBucket?: Bucket | VMImportBucket;
        subDirectoryName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxPipelineProps

    Properties

    imageRepo +
    interface EmbeddedLinuxPipelineProps {
        imageRepo: IRepository;
        imageTag?: string;
        vpc: IVpc;
        projectKind?: ProjectKind;
        layerRepoName?: string;
        buildPolicyAdditions?: PolicyStatement[];
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        outputBucket?: Bucket | VMImportBucket;
        subDirectoryName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxPipelineProps

    Properties

    imageRepo imageTag? vpc projectKind? @@ -22,17 +22,17 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlyimageRepo

    imageRepo: IRepository

    ECR Repository where the Build Host Image resides.

    -

    Optional ReadonlyimageTag

    imageTag?: string

    Tag for the Build Host Image

    -

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    -

    Optional ReadonlyprojectKind

    projectKind?: ProjectKind

    The type of project being built.

    -

    Optional ReadonlylayerRepoName

    layerRepoName?: string

    A name for the layer-repo that is created. Default is 'layer-repo'

    -

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    -

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    -

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    -

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    -

    Optional ReadonlyoutputBucket

    outputBucket?: Bucket | VMImportBucket

    Output bucket to use

    -

    Optional ReadonlysubDirectoryName

    subDirectoryName?: string

    Prefix for S3 object within bucket

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Optional ReadonlyimageTag

    imageTag?: string

    Tag for the Build Host Image

    +

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    +

    Optional ReadonlyprojectKind

    projectKind?: ProjectKind

    The type of project being built.

    +

    Optional ReadonlylayerRepoName

    layerRepoName?: string

    A name for the layer-repo that is created. Default is 'layer-repo'

    +

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    +

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    +

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    +

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    +

    Optional ReadonlyoutputBucket

    outputBucket?: Bucket | VMImportBucket

    Output bucket to use

    +

    Optional ReadonlysubDirectoryName

    subDirectoryName?: string

    Prefix for S3 object within bucket

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html index 1fb7ada..ca0b301 100644 --- a/interfaces/SourceRepoProps.html +++ b/interfaces/SourceRepoProps.html @@ -1,4 +1,4 @@ -SourceRepoProps | aws4embeddedlinux-cdk-lib

    Interface SourceRepoProps

    interface SourceRepoProps {
        repoName: string;
        kind: ProjectKind;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • SourceRepoProps

    Properties

    repoName +SourceRepoProps | aws4embeddedlinux-cdk-lib

    Interface SourceRepoProps

    interface SourceRepoProps {
        repoName: string;
        kind: ProjectKind;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • SourceRepoProps

    Properties

    repoName kind description? env? @@ -12,8 +12,8 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlyrepoName

    repoName: string

    The name of the CodeCommit Repository created.

    -

    Readonlykind

    kind: ProjectKind

    The type of project to seed this repository with.

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Readonlykind

    kind: ProjectKind

    The type of project to seed this repository with.

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    From fe24637f9062ad626eae70d4946ca331617ebd4b Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 24 Feb 2025 14:41:11 +0000 Subject: [PATCH 27/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@988e3208e975b87acf4e500324?= =?UTF-8?q?d86ec5f6e419ba=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- assets/highlight.css | 37 +- assets/main.js | 8 +- assets/navigation.js | 2 +- assets/search.js | 2 +- assets/style.css | 9 +- classes/BuildImageDataStack.html | 325 ----------------- classes/BuildImagePipelineStack.html | 325 ----------------- classes/BuildImageRepoStack.html | 326 ----------------- .../EmbeddedLinuxCodeBuildProjectStack.html | 324 +++++++++++++++++ ...beddedLinuxCodePipelineBaseImageStack.html | 329 +++++++++++++++++ classes/EmbeddedLinuxCodePipelineStack.html | 324 +++++++++++++++++ .../EmbeddedLinuxCodebuildProjectStack.html | 324 ----------------- classes/EmbeddedLinuxPipelineStack.html | 324 ----------------- classes/PipelineNetworkStack.html | 327 ----------------- classes/PipelineResourcesStack.html | 337 ++++++++++++++++++ classes/SourceRepo.html | 27 -- enums/ImageKind.html | 4 - enums/ProjectKind.html | 16 - enums/ProjectType.html | 18 + functions/isBucketVersioned.html | 1 + index.html | 277 +++++++++++--- interfaces/BuildImageDataProps.html | 94 ----- interfaces/BuildImagePipelineProps.html | 104 ------ .../EmbeddedLinuxCodeBuildProjectProps.html | 102 ++++++ ...beddedLinuxCodePipelineBaseImageProps.html | 102 ++++++ .../EmbeddedLinuxCodePipelineProps.html | 120 +++++++ .../EmbeddedLinuxCodebuildProjectProps.html | 114 ------ interfaces/EmbeddedLinuxPipelineProps.html | 114 ------ interfaces/PipelineResourcesProps.html | 104 ++++++ interfaces/SourceRepoProps.html | 95 ----- ...chitecture.svg => architecture-v0.2.x.svg} | 2 +- modules.html | 2 +- 32 files changed, 2019 insertions(+), 2600 deletions(-) delete mode 100644 classes/BuildImageDataStack.html delete mode 100644 classes/BuildImagePipelineStack.html delete mode 100644 classes/BuildImageRepoStack.html create mode 100644 classes/EmbeddedLinuxCodeBuildProjectStack.html create mode 100644 classes/EmbeddedLinuxCodePipelineBaseImageStack.html create mode 100644 classes/EmbeddedLinuxCodePipelineStack.html delete mode 100644 classes/EmbeddedLinuxCodebuildProjectStack.html delete mode 100644 classes/EmbeddedLinuxPipelineStack.html delete mode 100644 classes/PipelineNetworkStack.html create mode 100644 classes/PipelineResourcesStack.html delete mode 100644 classes/SourceRepo.html delete mode 100644 enums/ImageKind.html delete mode 100644 enums/ProjectKind.html create mode 100644 enums/ProjectType.html create mode 100644 functions/isBucketVersioned.html delete mode 100644 interfaces/BuildImageDataProps.html delete mode 100644 interfaces/BuildImagePipelineProps.html create mode 100644 interfaces/EmbeddedLinuxCodeBuildProjectProps.html create mode 100644 interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html create mode 100644 interfaces/EmbeddedLinuxCodePipelineProps.html delete mode 100644 interfaces/EmbeddedLinuxCodebuildProjectProps.html delete mode 100644 interfaces/EmbeddedLinuxPipelineProps.html create mode 100644 interfaces/PipelineResourcesProps.html delete mode 100644 interfaces/SourceRepoProps.html rename media/{architecture.svg => architecture-v0.2.x.svg} (66%) diff --git a/assets/highlight.css b/assets/highlight.css index bcb05ac..94afbea 100644 --- a/assets/highlight.css +++ b/assets/highlight.css @@ -3,22 +3,24 @@ --dark-hl-0: #9CDCFE; --light-hl-1: #000000; --dark-hl-1: #D4D4D4; - --light-hl-2: #795E26; - --dark-hl-2: #DCDCAA; - --light-hl-3: #A31515; - --dark-hl-3: #CE9178; - --light-hl-4: #AF00DB; - --dark-hl-4: #C586C0; - --light-hl-5: #0000FF; - --dark-hl-5: #569CD6; - --light-hl-6: #0070C1; - --dark-hl-6: #4FC1FF; - --light-hl-7: #800000; + --light-hl-2: #000000; + --dark-hl-2: #C8C8C8; + --light-hl-3: #0070C1; + --dark-hl-3: #4FC1FF; + --light-hl-4: #267F99; + --dark-hl-4: #4EC9B0; + --light-hl-5: #795E26; + --dark-hl-5: #DCDCAA; + --light-hl-6: #A31515; + --dark-hl-6: #CE9178; + --light-hl-7: #0000FF; --dark-hl-7: #569CD6; - --light-hl-8: #008000; - --dark-hl-8: #6A9955; - --light-hl-9: #267F99; - --dark-hl-9: #4EC9B0; + --light-hl-8: #AF00DB; + --dark-hl-8: #C586C0; + --light-hl-9: #800000; + --dark-hl-9: #569CD6; + --light-hl-10: #008000; + --dark-hl-10: #6A9955; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -34,6 +36,7 @@ --hl-7: var(--light-hl-7); --hl-8: var(--light-hl-8); --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); --code-background: var(--light-code-background); } } @@ -48,6 +51,7 @@ --hl-7: var(--dark-hl-7); --hl-8: var(--dark-hl-8); --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); --code-background: var(--dark-code-background); } } @@ -62,6 +66,7 @@ --hl-7: var(--light-hl-7); --hl-8: var(--light-hl-8); --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); --code-background: var(--light-code-background); } @@ -76,6 +81,7 @@ --hl-7: var(--dark-hl-7); --hl-8: var(--dark-hl-8); --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); --code-background: var(--dark-code-background); } @@ -89,4 +95,5 @@ .hl-7 { color: var(--hl-7); } .hl-8 { color: var(--hl-8); } .hl-9 { color: var(--hl-9); } +.hl-10 { color: var(--hl-10); } pre, code { background: var(--code-background); } diff --git a/assets/main.js b/assets/main.js index 4f59cd9..2363f64 100644 --- a/assets/main.js +++ b/assets/main.js @@ -1,9 +1,9 @@ "use strict"; -window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse"}; +window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse","folder":"Folder","kind_1":"Project","kind_2":"Module","kind_4":"Namespace","kind_8":"Enumeration","kind_16":"Enumeration Member","kind_32":"Variable","kind_64":"Function","kind_128":"Class","kind_256":"Interface","kind_512":"Constructor","kind_1024":"Property","kind_2048":"Method","kind_4096":"Call Signature","kind_8192":"Index Signature","kind_16384":"Constructor Signature","kind_32768":"Parameter","kind_65536":"Type Literal","kind_131072":"Type Parameter","kind_262144":"Accessor","kind_524288":"Get Signature","kind_1048576":"Set Signature","kind_2097152":"Type Alias","kind_4194304":"Reference","kind_8388608":"Document"}; "use strict";(()=>{var De=Object.create;var le=Object.defineProperty;var Fe=Object.getOwnPropertyDescriptor;var Ne=Object.getOwnPropertyNames;var Ve=Object.getPrototypeOf,Be=Object.prototype.hasOwnProperty;var qe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var je=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ne(e))!Be.call(t,i)&&i!==n&&le(t,i,{get:()=>e[i],enumerable:!(r=Fe(e,i))||r.enumerable});return t};var $e=(t,e,n)=>(n=t!=null?De(Ve(t)):{},je(e||!t||!t.__esModule?le(n,"default",{value:t,enumerable:!0}):n,t));var pe=qe((de,he)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,c],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[c+1]*i[d+1],c+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}s.str.length==1&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),p;m in s.node.edges?p=s.node.edges[m]:(p=new t.TokenSet,s.node.edges[m]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof de=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse"};var ce=[];function G(t,e){ce.push({selector:e,constructor:t})}var J=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){ce.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!ze(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function ze(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var ge=$e(pe(),1);async function H(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}async function fe(t,e){if(!window.searchData)return;let n=await H(window.searchData);t.data=n,t.index=ge.Index.load(n.index),e.classList.remove("loading"),e.classList.add("ready")}function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:document.documentElement.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{fe(e,t)}),fe(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");i.addEventListener("mouseup",()=>{re(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),We(t,i,r,e)}function We(t,e,n,r){n.addEventListener("input",ue(()=>{Ue(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Je(e,t):i.key=="ArrowUp"?(me(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(me(e,n,1),i.preventDefault())}),document.body.addEventListener("keypress",i=>{i.altKey||i.ctrlKey||i.metaKey||!n.matches(":focus")&&i.key==="/"&&(i.preventDefault(),n.focus())}),document.body.addEventListener("keyup",i=>{t.classList.contains("has-focus")&&(i.key==="Escape"||!e.matches(":focus-within")&&!n.matches(":focus"))&&(n.blur(),re(t))})}function re(t){t.classList.remove("has-focus")}function Ue(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ye(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` - ${ye(l.parent,i)}.${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=c+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function me(t,e,n){let r=t.querySelector(".current");if(!r)r=t.querySelector(n==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let i=r;if(n===1)do i=i.nextElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);else do i=i.previousElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);i?(r.classList.remove("current"),i.classList.add("current")):n===-1&&(r.classList.remove("current"),e.focus())}}function Je(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),re(e)}}function ye(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ne(t.substring(s,o)),`${ne(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ne(t.substring(s))),i.join("")}var Ge={"&":"&","<":"<",">":">","'":"'",'"':"""};function ne(t){return t.replace(/[&<>"'"]/g,e=>Ge[e])}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var A="mousedown",Ee="mousemove",B="mouseup",X={x:0,y:0},xe=!1,ie=!1,Xe=!1,D=!1,Le=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Le?"is-mobile":"not-mobile");Le&&"ontouchstart"in document.documentElement&&(Xe=!0,A="touchstart",Ee="touchmove",B="touchend");document.addEventListener(A,t=>{ie=!0,D=!1;let e=A=="touchstart"?t.targetTouches[0]:t;X.y=e.pageY||0,X.x=e.pageX||0});document.addEventListener(Ee,t=>{if(ie&&!D){let e=A=="touchstart"?t.targetTouches[0]:t,n=X.x-(e.pageX||0),r=X.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ie=!1});document.addEventListener("click",t=>{xe&&(t.preventDefault(),t.stopImmediatePropagation(),xe=!1)});var Y=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(A,n=>this.onDocumentPointerDown(n)),document.addEventListener(B,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var se;try{se=localStorage}catch{se={getItem(){return null},setItem(){}}}var C=se;var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var Z=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=C.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){C.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var oe=new Map,ae=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;C.setItem(this.key,e.toString())}},K=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(oe.has(i))s=oe.get(i);else{let o=C.getItem(i),a=o?o==="true":this.el.open;s=new ae(i,a),oe.set(i,s)}s.add(this.el)}};function Se(t){let e=C.getItem("tsd-theme")||"os";t.value=e,we(e),t.addEventListener("change",()=>{C.setItem("tsd-theme",t.value),we(t.value)})}function we(t){document.documentElement.dataset.theme=t}var ee;function Ce(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Te),Te())}async function Te(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await H(window.navigationData);ee=document.documentElement.dataset.base,ee.endsWith("/")||(ee+="/"),t.innerHTML="";for(let n of e)Ie(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ie(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',ke(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let c of t.children)Ie(c,l,i)}else ke(t,r,t.class)}function ke(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=ee+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else{let r=e.appendChild(document.createElement("span"));r.innerHTML='',r.appendChild(document.createElement("span")).textContent=t.text}}var te=document.documentElement.dataset.base;te.endsWith("/")||(te+="/");function Pe(){document.querySelector(".tsd-full-hierarchy")?Ye():document.querySelector(".tsd-hierarchy")&&Ze()}function Ye(){document.addEventListener("click",r=>{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=tt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function Ze(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Qe),Qe())}async function Qe(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await H(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),Ke(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function Ke(t,e,n){let r=e.roots.filter(i=>et(e,i,n));for(let i of r)t.appendChild(Oe(e,i,n))}function Oe(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let l=t.reflections[a],c=s.appendChild(document.createElement("a"));c.textContent=l.name,c.href=te+l.url,c.className=l.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=te+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let l=Oe(t,a,n,r);l&&o.appendChild(l)}}return r.delete(e),s}function et(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function tt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.setAttribute("viewBox","0 0 24 24"),t.setAttribute("fill","none"),t.innerHTML='',t}G(Y,"a[data-toggle]");G(K,".tsd-accordion");G(Z,".tsd-filter-item input[type=checkbox]");var _e=document.getElementById("tsd-theme");_e&&Se(_e);var nt=new J;Object.defineProperty(window,"app",{value:nt});ve();Ce();Pe();})(); +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[c+1]*i[d+1],c+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}s.str.length==1&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),p;m in s.node.edges?p=s.node.edges[m]:(p=new t.TokenSet,s.node.edges[m]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof de=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var ce=[];function G(t,e){ce.push({selector:e,constructor:t})}var J=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){ce.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!ze(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function ze(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var ge=$e(pe(),1);async function A(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}async function fe(t,e){if(!window.searchData)return;let n=await A(window.searchData);t.data=n,t.index=ge.Index.load(n.index),e.classList.remove("loading"),e.classList.add("ready")}function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:document.documentElement.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{fe(e,t)}),fe(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");i.addEventListener("mouseup",()=>{re(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),We(t,i,r,e)}function We(t,e,n,r){n.addEventListener("input",ue(()=>{Ue(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Je(e,t):i.key=="ArrowUp"?(me(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(me(e,n,1),i.preventDefault())}),document.body.addEventListener("keypress",i=>{i.altKey||i.ctrlKey||i.metaKey||!n.matches(":focus")&&i.key==="/"&&(i.preventDefault(),n.focus())}),document.body.addEventListener("keyup",i=>{t.classList.contains("has-focus")&&(i.key==="Escape"||!e.matches(":focus-within")&&!n.matches(":focus"))&&(n.blur(),re(t))})}function re(t){t.classList.remove("has-focus")}function Ue(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ye(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ye(l.parent,i)}.${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=c+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function me(t,e,n){let r=t.querySelector(".current");if(!r)r=t.querySelector(n==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let i=r;if(n===1)do i=i.nextElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);else do i=i.previousElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);i?(r.classList.remove("current"),i.classList.add("current")):n===-1&&(r.classList.remove("current"),e.focus())}}function Je(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),re(e)}}function ye(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ne(t.substring(s,o)),`${ne(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ne(t.substring(s))),i.join("")}var Ge={"&":"&","<":"<",">":">","'":"'",'"':"""};function ne(t){return t.replace(/[&<>"'"]/g,e=>Ge[e])}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var H="mousedown",Ee="mousemove",B="mouseup",X={x:0,y:0},xe=!1,ie=!1,Xe=!1,D=!1,be=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(be?"is-mobile":"not-mobile");be&&"ontouchstart"in document.documentElement&&(Xe=!0,H="touchstart",Ee="touchmove",B="touchend");document.addEventListener(H,t=>{ie=!0,D=!1;let e=H=="touchstart"?t.targetTouches[0]:t;X.y=e.pageY||0,X.x=e.pageX||0});document.addEventListener(Ee,t=>{if(ie&&!D){let e=H=="touchstart"?t.targetTouches[0]:t,n=X.x-(e.pageX||0),r=X.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ie=!1});document.addEventListener("click",t=>{xe&&(t.preventDefault(),t.stopImmediatePropagation(),xe=!1)});var Y=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(H,n=>this.onDocumentPointerDown(n)),document.addEventListener(B,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var se;try{se=localStorage}catch{se={getItem(){return null},setItem(){}}}var C=se;var Le=document.head.appendChild(document.createElement("style"));Le.dataset.for="filters";var Z=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),Le.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=C.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){C.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var oe=new Map,ae=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;C.setItem(this.key,e.toString())}},K=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(oe.has(i))s=oe.get(i);else{let o=C.getItem(i),a=o?o==="true":this.el.open;s=new ae(i,a),oe.set(i,s)}s.add(this.el)}};function Se(t){let e=C.getItem("tsd-theme")||"os";t.value=e,we(e),t.addEventListener("change",()=>{C.setItem("tsd-theme",t.value),we(t.value)})}function we(t){document.documentElement.dataset.theme=t}var ee;function Ce(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Te),Te())}async function Te(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await A(window.navigationData);ee=document.documentElement.dataset.base,ee.endsWith("/")||(ee+="/"),t.innerHTML="";for(let n of e)Ie(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ie(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',ke(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let c of t.children)Ie(c,l,i)}else ke(t,r,t.class)}function ke(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=ee+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&r.classList.add("current"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(document.createElement("span")).textContent=t.text}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(document.createElement("span")).textContent=t.text}}var te=document.documentElement.dataset.base;te.endsWith("/")||(te+="/");function Pe(){document.querySelector(".tsd-full-hierarchy")?Ye():document.querySelector(".tsd-hierarchy")&&Ze()}function Ye(){document.addEventListener("click",r=>{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=tt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function Ze(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Qe),Qe())}async function Qe(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await A(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),Ke(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function Ke(t,e,n){let r=e.roots.filter(i=>et(e,i,n));for(let i of r)t.appendChild(_e(e,i,n))}function _e(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let l=t.reflections[a],c=s.appendChild(document.createElement("a"));c.textContent=l.name,c.href=te+l.url,c.className=l.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=te+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let l=_e(t,a,n,r);l&&o.appendChild(l)}}return r.delete(e),s}function et(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function tt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.setAttribute("viewBox","0 0 24 24"),t.setAttribute("fill","none"),t.innerHTML='',t}G(Y,"a[data-toggle]");G(K,".tsd-accordion");G(Z,".tsd-filter-item input[type=checkbox]");var Oe=document.getElementById("tsd-theme");Oe&&Se(Oe);var nt=new J;Object.defineProperty(window,"app",{value:nt});ve();Ce();Pe();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/assets/navigation.js b/assets/navigation.js index 19e4c8a..fcf930a 100644 --- a/assets/navigation.js +++ b/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJyNkk+LwjAQxb/LnMuKwor06J+DrCxlPS4eYjJqtm1SkikriN9dLNpa2yQ9z++9zHuZ3wsQnglimJcyE+ucHXHJiCVGFxYiKBidIAapCM2BcbSjHu7jRHkGEaRSCYgnn9Nr5LDdEuNpY8szZm3Hs4LanuPJ7MWzIr/ug9oJVZnbUT1oq2e9+ySywEwqHBK1xQ6L+5QEI7dAX+xG8oOFDvrWkM8zMfoPOfWV+TJy17nVpeHVU+4a3xhffQ3aTdbMfIFW+R6FQLGRqjwvtMD9vZBHFveOYZlvba/a8VFhzeCY4Ut244NjBe7ZzXrP7wF+I/1rkzq8+6iu6+4GYwiuog==" \ No newline at end of file +window.navigationData = "eJydk01Lw0AQhv/LnIPBoqXkGPEgeAgqXsTDuvvWTpPshp1dqEj/u6BIGpImTc7zfj2HefumgEOgjO7rDxgD88g2Hu6cQR65MoV3e+hQeNcIJdSosKOM2Ab4rdKQdNp2tQt1RQmVbA1lq9v1Mbms9DkoXbalulIiU42/nm7j9Woz1lhwg4otciV4qNUnZrAOe2cB9yIupR42LkJfQLwcdC7fJNa/8AnioteQ8zjD0jGMnuPM/GHd2GyWPOoS4RVe2FmYNnQbrQ7srKQ9UTdxfXM69e8DXr4atFGwsZb05NQN2BzffwDRUm8P" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js index d6cee41..1eae977 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "eJy1m0tv4zYQx78LcxWy5kt+3LbdHhZtF0FfFyMoFFubqrEtQ5J3EwT57gX1sGY8pEQq7sm7Nmfmz9GPw5GovLIi/16y1fqVPWWHLVtxsYjYIdmnbMXusmO6yw7pl7T6nhdPv1fJ5olF7FTs2IptdklZpuUH26Dbf6r9jkXdGLZi7C3qImguzhE2+aGsitOmygt/xzfYCgSJ2DEp0kPl0t6L4DOhziq+HTcB0ZvRk6IKHZ+D/nDKdtvP++Qx/ZRUyV2RH8uziOxQpcXXZJOWHyzDBrOLJvZw2jyl1RfznwDXN43ZoTGzT9SmHogAEOGRdoYsY66CkMuvF0E24YN59g9/Hj8psjW5v6XHfCy55zFXTi72G5jcXrgjuUV6zMusyosXfwnIZoqCPsX1kJ/Nl1309HDalx/O3w8vx37B//lwOlQnIf6eqUFXNyc00K6+VzVWXbqS5FFh0FD/KpORDHl6v6ktnxrLsauE5+GQsk2q5Ae8GH21GFPvdeklxgKur5ggfr3EJJtNWpa/5I+P2eFxYooaH7vGx3VzVabFt7T42Iks74r0a/YcrLBxc9ZZHjs318lhUWVfk001NX2t+fszZ90ButFjuwAad+WdgPoO3A3wJOy17af9Q7rdpttfssPpebS8uUcHVjizTUwI0BS5ojG2T39gQkOC/kgeJ+upattryYENdICSoU46XMSxyP9NN5VrIxoT05oP7kbhonbJS1oYclxN+Jis2oGhZ7AdDxf2YJbcXb7LNi8ft9usyvLDlOVzU/s51n4S4OdaMj23rTGVITtXuEj/zWtMZ+D+NSGfo1vYaCr9drFwafmpOp7eIayxv/7FPT18yorU7F8vUxdxeXrYdj6usI7B9m81sHcA7qFXaQJG3Hv1AQOz8WgFfsy3aVPWmlLu1xJYrf6P1sAdKLRFsE/0va3CmD7vliFInk/rMKDMu4UIEhXSSgyIC24pgkSGtRYDMie0GEFCJ7UaA3qntxxBsqe0HgOqJ7cgQaIntiIDut/TkoTlO6w1GUr1hBYlSGpQqzIgNLxlCYMhtHUZwmBSCzMq19XKXBp6tDRWk+u3Nu4w4S2OfZa2p9B3lh2peXgMfvF9En2XP72MeLk5NmMcx1xAjTXCr2mVfPxefkr3+VigfVolyfdy2wydGM/M6OM+85lUUg+bGOfnpByL8ZS4N6NR/7+lh7Qcj1Gch02M8+X5+Hn/PBbm8HzM9u5SPxrF4F0/2hsLtOnWQWAseCvwe34qNnUn7uz7L4b4N/nFQJdlc3oz2k1dqnUEfnJ0oNagg33mQEBQg/tRpAj2P12lpl6486qdQN3AhRoNNXijBWPcRyw7bNNntnpl39KizPIDWzFxK2+XLGJfs3S3Na9OsO5K5/u9cRKxbb451f+8b4f9VW+cZnAz+sOMRetZJOe38WJ5fx+tO+P6h/qLzkf/TW3IWbTmkeC3eqmRISeGHBkKFq1FJJa3gsfIUBBDgQwli9bSJlUSQ4kMFYvWymaoiKFChppFa20z1MRQI8PYlZyYGMbIcM6idWyLOCeGc2S4YNF6bjNcEMMFMly6pC6J4RIDYHhYRFLc6gXHBFB2+AU8Boml1daCD+aHGyq4lVlOEeKYIW7I4NxqTDHimCOunKopSRyjxA0gXFgDU5o4xonHzlRToDgmihtOuLQtOE6h4pgqbljhympMweKYLF6jpa3GFC6O6RIGGG5dCoLiJTBewlmcBMVLXJSnGi/rUhKWCoXxEjVe1islKF4C4yUMMdzKl6B8CcyX0M6ySvESGC9hiBEzqzHlS2C+hCFGcKtqypfAfAlDjBBWY8qXwHyJpZNsQfkSmC85c5ItKV8S8yW5k2xJAZMYMFlvgNI2Z0kBkxd7oEFGKKuxZRvEgEmDjLBuaJICJjFgUrvWlKSASQyYrAGzLmZJAZMYMDl3rilJAZMYMLlwrilJAZMYMLl0rSlJ+ZKYLzVzrilF+VKYL8Wda0pRvhTmSwnnmlKUL4X5UtK5phTlS130Wcq5ppSl1cJ8Ke1cU4oCpjBgKnauKUUBUxgwNXeuKUUBUxgwVVcw63ahKGAKA6aczZeigCkMmHYDpilgGgOma8AW1taWAqYxYLoGbGk1poBpDJiuu3hr96YpYBoDpg0y0tq9aQqYvmjmDTLS2oFpSz+PAdMGGWm9+9AUMI0B0wYZab0D0RQwjQHTBhlpvwuhgGkMmDbMSGvh1ZQwjQmLDTPSinZMCYsxYbFhRloJiylhMSYsFs77JwpYjAGLa8CsdMYUsPar+gb7W1pU6fZzc6O9XjPrQckr+7u9Feeyu9t/ZXzOVq9vERPL5lNJ8/nW34rX357vxs1vRsbl+QBwroHz1qnkrXPt5Zw6jXuf8wAXzVOF3o3q3ShPN9luWx/dmndbj81Tsd4fyKNf2rC/snki3/sDqfPNVOfv2B71E42cg+sRqrLzSpRycEXELNBr/Wrupcd573Dh74+cYfYOhQASFy2Awss1eJgKLjagR/tRiJ7IgeSBK9JYxs1Hu1xE+63Urer2+9hPPXwNGwQF6eB+dKXtQcvOHLScc9IeyRPQBEBCxu8PQAgRABHlxwgK4F4iwLHwy7HVMVUMFrT0qzjgff7ezxJcupYNHuCueVoL5rsA85Uta35E96+xAHdAnlCtO7/rU5/0gCUGVob2m+BlqiS4lrFfYbp4eQNcPiBHtPuk4l4+0ZEc8AhSpf1I606QwBTBtqP9Fho+JQd64A4m2hn6ueygPzR/p0fYn/We/S5Dc1wKtAFKtV/Wz4eTIFlAh/bb/tA7R0AP8CTagq1mzaf2m+L50BHoA2VZ+5Xly+UsAVSx3xRttEtQv/XS2033Nza9I3DdeJsf7seU60UZUGvAJszbTV22QZRfxSjr4ymSRKA69qOtd0QbQ9jJ+ZVC+nYIQA/MWrYFW/kVbPSXcCCPAGbuV4jq9wSBJrAa2ralbVekBzz30bmAsNX6/u3tP4DETfQ="; \ No newline at end of file +window.searchData = "eJy9m01v2zgQhv8LcxVS88tft3bRQ9FFN9sWvRhBochMqo0taSU5myDIf19Qoq2hh5IpWe7JgcOZeUk+HA4p+ZXk6X8FWa5eyWOcrMlyKgKShFtFliQuPuyiR1X+UHkRp4lak4Ds8g1ZkvtdEpVxmhTvUJvrX+V2QwISbcKiUAVZEvIW7J3PD75v8vQfFZXfXzJ18KqS3bZ4B/7T6YtOG2fp48sJL1dZ3Qa4CkgW5iopj9Q4I/z9cbs7FeFfVbUZGEH34f029ulGWDUbGOdzWJyK8Vg1Gej/q0pUcTpGfmg2MM6X5+zT9vlUmOQ5i6tWA6P8ka7Vh128WZ8KFKVrdWcaDo21K8p0ezLQvlWfKEw2YT5u79R6rdZ/xsnu+dA/Y3eTp1kzd3FSqvw+jFTx7rRV92KdsCavqCj/qrK0iMs0fzkj2JWK8hw6cg+JR4d9hH7ahg/qe/gwmuBYOywrh2MLf8qic2TW5mOLqpbHTbqJo5f363Vc7R/nqKz8ZZW/EPgbHYIkyl8y7f2zOo/Wg6NHNRatbO63rr+VYfR4EG8idyuvTDoXtaTsED1Kk6LMd1GZ5kPDXNk+BgxP3UvPtHcTZ2oTJ+pDWKhqbfvnPrepfwLMjP23dJdHqi6gzg18tXdaVE7v9k49h7FlNLw6cJOr+/h55A5ke6cX7cD7vIzvw6gceQ5C4/ays9B/H+3SPnAz7Sm5dzLtlDwso56W3JVWkbVnbnXbXSbBdsQalmVbOt0LzEFqx6LSXy+q887X3b/SO6nfa2vrv6P97o1s9P3rstvW6LvVpTepC+xNvSSPM8Z7yRcd5b92ZbYbaYzTytdFR7iWO8741nIvMrrDa5TxSpMLnfFPCR2e9bsBcNyc9p332kVZuxhTnO/Fg0NUr0sHLzGDLxwc6s67bPAjMXmK8zTZqqT8EeZxeLdRg+UCX0/A17hyh5by41XwnQLrnbm+Vb0Jy19DNdZ+6nvXrPZzrkyf80XPY8VvOE2MdYjoqmX3bb6awqporWHdLf1r19zY/cxa99COEFfYvOVC3t0hn93oi/6upyxrB0pqB2MIc9eiQxS669ALSIWHknOEwgPJBWTCuvMcmbDmHFHmJn14iJOH4fqMg1GEgbyJGrvzpbvZKHmyw7VXfmzpgUdl5aOgq5zqF7n7NqdLg1/d3k/NiUOxj6yeJ+Fh+pxXIn3Ued2DDNPmPOr20eZ1vu2nzcozvURZCWYs5p3FrRfzXhVtm5rbgMTJWj2T5St5ql+pIUvCrvn1ggTkPlabtX5Zh+zzaLrVJT4JyDqNdtWft6bZD6WTj25ct343IcFqEvDZNaOz29tgtTeu/lF9sffRfFMZUhKsaMDZNZ3MLUOKDKllyEiwYq6IDBkyy5CTYMVdhhwZcstQkGAlXIYCGQrLUJJgJV2GEhlKy3BKgtXUZThFhlPLcEaC1cxlOEOGM8twToLV3GU4R4Zzy3BBgtXCZbhAhgsbAM0DdbJDMTz0iJ4KHxowcc2YsI0dANkEUc0FZQGbX8/EkTGGiNoUUc0G5U5jDBK1SaKaDyqc2GOYqE0T1YxQGbDpNePUNsZAUZsoqjmhTqYohoraVFHNCp05I2OwqE0W1bxQJ1sUw0Vtuqhmhi6co40BozZhTDPDJq7RZpgwZhPGNDOMuiIzTBg7ylGsFU/mSFM2YYy3zjPDhDGbMKaZYe78iAljNmFMts4zw4QxmzA2be8zJozZhLFZ65JkmDBmE8Y0M8yZ2hkmjNmEsXbCGCaM2YTxdsI4JozbhPF2wjgmjNuE8WobdO5KHBPGj3ZCzQyTTtmOzdAmjFeEOTMJx4RxmzAuWyHhmDBuE8anrZBwTBi3CeOztoKDY8C4DRift+Z8jgHjNmB80ZrzOQaM24CJCjDnji4wYMIGTNDWRCIwYMIGTFSAOdO2wIAJGzBRAeYsCwQGTByVW6I1CwlHxWUDJjQy3FlVCAyYsAETGhlOncYYMGEDJjQz3Jl5BSZM2IQJzQx3pjCBCRM2YUIzw90VKiZM2IRJzQx3V6mYMGkTJjUz3JkLJCZM2oRJzQx3si0xYdImTPJWSCQmTNqESdG6niUmTB4V9e0pTDrqepswOW3N+RITJm3C5Kx1q5KYMGkTJuetOV9iwqRNmKwIcyYDiQmTNmHTSWsammLCzFfVkfVJ5aVaf6qPrqsVcT8ueyU/zemWHo7ar4QKsnx9Cwhf6M+35lRbfXs42Or/1YoOb9o3/uaNu7mnF3BBB3TNgK5Zbctk/SmMTsn9IpgX9Rvni8a3X1eP7s+ATApkUiOTmc+pGU4jW8r+sZpH1yAmAzH3scwQ8Wn/GPUVRuOfA/9i5ufPPGHa6CdMBy7M0+2sfnAEOjABHZicH6CoL5xBgCkI4DkixwH2N2x3YaGqWcDdAKxTP9hPR0F9YWA2mDgvCuoC48D5mV3AysEyE35L9ejODoy1BGNt1hPjJh2YdTf1RMn5RB7IBplH+LmMi/rO86n5fV7jD8Du56361VdjD3rul0COrmHBwgbASr/E53hmBPyBZSapl7/9z8AaJ2C0/XJN20MDMIMgKTMDBzef0i8ddD0bBQMAlo/wWz5tb9IB9WBH5qyXU/tpAHAJGOJm1ch+evFDTTAMEFE/xt0vvAHFAC3ul/X2LvfvAxQo23GwFIXfWkJOUZbjAGDZb7rsB0sg2YHESRcm2ZlP2W+R4EfmQDkATfilA/e7tmDawAiziVl5nkRUPwsGroAnbwfVD3IbH7CDfj7g+3hgQsB8mE75TUP9S2Qw5IBqLweHX+c2PsDK8Mtl6AUZoAf0TPh5wy9hgTkDG4zwm7Xq6TgYaTBC1GQqPjfoe8zhbXBglCxXt29v/wN3JlW7"; \ No newline at end of file diff --git a/assets/style.css b/assets/style.css index 7f80f3d..2ab8b83 100644 --- a/assets/style.css +++ b/assets/style.css @@ -991,14 +991,15 @@ vertical-align: text-top; } /* - We need to be careful to target the arrow indicating whether the accordion - is open, but not any other SVGs included in the details element. -*/ + * We need to be careful to target the arrow indicating whether the accordion + * is open, but not any other SVGs included in the details element. + */ .tsd-accordion:not([open]) > .tsd-accordion-summary > svg:first-child, .tsd-accordion:not([open]) > .tsd-accordion-summary > h1 > svg:first-child, .tsd-accordion:not([open]) > .tsd-accordion-summary > h2 > svg:first-child, .tsd-accordion:not([open]) > .tsd-accordion-summary > h3 > svg:first-child, - .tsd-accordion:not([open]) > .tsd-accordion-summary > h4 > svg:first-child { + .tsd-accordion:not([open]) > .tsd-accordion-summary > h4 > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h5 > svg:first-child { transform: rotate(-90deg); } .tsd-index-content > :not(:first-child) { diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html deleted file mode 100644 index 366adce..0000000 --- a/classes/BuildImageDataStack.html +++ /dev/null @@ -1,325 +0,0 @@ -BuildImageDataStack | aws4embeddedlinux-cdk-lib

    Class BuildImageDataStack

    Input (Source) data for our BuildImagePipelineStack.

    -

    Hierarchy

    • Stack
      • BuildImageDataStack

    Constructors

    constructor -

    Properties

    bucket -tags -templateOptions -region -account -environment -nestedStackResource? -templateFile -artifactId -synthesizer -_versionReportingEnabled -_crossRegionReferences -_notificationArns? -node -

    Accessors

    terminationProtection -dependencies -stackName -partition -urlSuffix -stackId -notificationArns -nested -availabilityZones -nestedStackParent -bundlingRequired -

    Methods

    isStack -of -resolve -toJsonString -toYamlString -reportMissingContextKey -renameLogicalId -getLogicalId -addDependency -formatArn -splitArn -addTransform -addMetadata -_addAssemblyDependency -_obtainAssemblyDependencies -_removeAssemblyDependency -_synthesizeTemplate -regionalFact -exportValue -exportStringListValue -allocateLogicalId -_validateId -_toCloudFormation -isConstruct -toString -

    Constructors

    constructor

    Properties

    Readonlybucket

    bucket: IBucket

    The bucket which will be consumed by the BuildImagePipelineStack.

    -

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    -

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    -

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    -

    This value is resolved according to the following rules:

    -
      -
    1. The value provided to env.region when the stack is defined. This can -either be a concrete region (e.g. us-west-2) or the Aws.REGION -token.
      2. -
    2. Aws.REGION, which is represents the CloudFormation intrinsic reference -{ "Ref": "AWS::Region" } encoded as a string token.
      3. -
    -

    Preferably, you should use the return value as an opaque string and not -attempt to parse it to implement your logic. If you do, you must first -check that it is a concrete value an not an unresolved token. If this -value is an unresolved token (Token.isUnresolved(stack.region) returns -true), this implies that the user wishes that this stack will synthesize -into a region-agnostic template. In this case, your code should either -fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or -implement some other region-agnostic behavior.

    -

    Readonlyaccount

    account: string

    The AWS account into which this stack will be deployed.

    -

    This value is resolved according to the following rules:

    -
      -
    1. The value provided to env.account when the stack is defined. This can -either be a concrete account (e.g. 585695031111) or the -Aws.ACCOUNT_ID token.
      2. -
    2. Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference -{ "Ref": "AWS::AccountId" } encoded as a string token.
      3. -
    -

    Preferably, you should use the return value as an opaque string and not -attempt to parse it to implement your logic. If you do, you must first -check that it is a concrete value an not an unresolved token. If this -value is an unresolved token (Token.isUnresolved(stack.account) returns -true), this implies that the user wishes that this stack will synthesize -into a account-agnostic template. In this case, your code should either -fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or -implement some other region-agnostic behavior.

    -

    Readonlyenvironment

    environment: string

    The environment coordinates in which this stack is deployed. In the form -aws://account/region. Use stack.account and stack.region to obtain -the specific values, no need to parse.

    -

    You can use this value to determine if two stacks are targeting the same -environment.

    -

    If either stack.account or stack.region are not concrete values (e.g. -Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or -unknown-region will be used respectively to indicate this stack is -region/account-agnostic.

    -

    Optional ReadonlynestedStackResource

    nestedStackResource?: CfnResource

    If this is a nested stack, this represents its AWS::CloudFormation::Stack -resource. undefined for top-level (non-nested) stacks.

    -

    ReadonlytemplateFile

    templateFile: string

    The name of the CloudFormation template file emitted to the output -directory during synthesis.

    -

    Example value: MyStack.template.json

    -

    ReadonlyartifactId

    artifactId: string

    The ID of the cloud assembly artifact for this stack.

    -

    Readonlysynthesizer

    synthesizer: IStackSynthesizer

    Synthesis method for this stack

    -

    Readonly Internal_versionReportingEnabled

    _versionReportingEnabled: boolean

    Whether version reporting is enabled for this stack

    -

    Controls whether the CDK Metadata resource is injected

    -

    Readonly Internal_crossRegionReferences

    _crossRegionReferences: boolean

    Whether cross region references are enabled for this stack

    -

    Optional Readonly Internal_notificationArns

    _notificationArns?: string[]

    SNS Notification ARNs to receive stack events.

    -

    Readonlynode

    node: Node

    The tree node.

    -

    Accessors

    terminationProtection

    • get terminationProtection(): boolean

    • Whether termination protection is enabled for this stack.

      -

      Returns boolean

    • set terminationProtection(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    dependencies

    • get dependencies(): Stack[]

    • Return the stacks this stack depends on

      -

      Returns Stack[]

    stackName

    • get stackName(): string

    • The concrete CloudFormation physical stack name.

      -

      This is either the name defined explicitly in the stackName prop or -allocated based on the stack's location in the construct tree. Stacks that -are directly defined under the app use their construct id as their stack -name. Stacks that are defined deeper within the tree will use a hashed naming -scheme based on the construct path to ensure uniqueness.

      -

      If you wish to obtain the deploy-time AWS::StackName intrinsic, -you can use Aws.STACK_NAME directly.

      -

      Returns string

    partition

    • get partition(): string

    • The partition in which this stack is defined

      -

      Returns string

    urlSuffix

    • get urlSuffix(): string

    • The Amazon domain suffix for the region in which this stack is defined

      -

      Returns string

    stackId

    • get stackId(): string

    • The ID of the stack

      -

      Returns string

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
-
      - -

    notificationArns

    • get notificationArns(): string[]

    • Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      -

      Returns string[]

    nested

    • get nested(): boolean

    • Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      -

      Returns boolean

    availabilityZones

    • get availabilityZones(): string[]

    • Returns the list of AZs that are available in the AWS environment -(account/region) associated with this stack.

      -

      If the stack is environment-agnostic (either account and/or region are -tokens), this property will return an array with 2 tokens that will resolve -at deploy-time to the first two availability zones returned from CloudFormation's -Fn::GetAZs intrinsic function.

      -

      If they are not available in the context, returns a set of dummy values and -reports them as missing, and let the CLI resolve them by calling EC2 -DescribeAvailabilityZones on the target environment.

      -

      To specify a different strategy for selecting availability zones override this method.

      -

      Returns string[]

    nestedStackParent

    • get nestedStackParent(): undefined | Stack

    • If this is a nested stack, returns it's parent stack.

      -

      Returns undefined | Stack

    bundlingRequired

    • get bundlingRequired(): boolean

    • Indicates whether the stack requires bundling or not

      -

      Returns boolean

    Methods

    StaticisStack

    • isStack(x: any): x is Stack

    • Return whether the given object is a Stack.

      -

      We do attribute detection since we can't reliably use 'instanceof'.

      -

      Parameters

      • x: any

      Returns x is Stack

    Staticof

    • of(construct: IConstruct): Stack

    • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      -

      Parameters

      • construct: IConstruct

        The construct to start the search from.

        -

      Returns Stack

    resolve

    • resolve(obj: any): any

    • Resolve a tokenized value in the context of the current stack.

      -

      Parameters

      • obj: any

      Returns any

    toJsonString

    • toJsonString(obj: any, space?: number): string

    • Convert an object, potentially containing tokens, to a JSON string

      -

      Parameters

      • obj: any
      • Optionalspace: number

      Returns string

    toYamlString

    • toYamlString(obj: any): string

    • Convert an object, potentially containing tokens, to a YAML string

      -

      Parameters

      • obj: any

      Returns string

    reportMissingContextKey

    • reportMissingContextKey(report: MissingContext): void

    • Indicate that a context key was expected

      -

      Contains instructions which will be emitted into the cloud assembly on how -the key should be supplied.

      -

      Parameters

      • report: MissingContext

        The set of parameters needed to obtain the context

        -

      Returns void

    renameLogicalId

    • renameLogicalId(oldId: string, newId: string): void

    • Rename a generated logical identities

      -

      To modify the naming scheme strategy, extend the Stack class and -override the allocateLogicalId method.

      -

      Parameters

      • oldId: string
      • newId: string

      Returns void

    getLogicalId

    • getLogicalId(element: CfnElement): string

    • Allocates a stack-unique CloudFormation-compatible logical identity for a -specific resource.

      -

      This method is called when a CfnElement is created and used to render the -initial logical identity of resources. Logical ID renames are applied at -this stage.

      -

      This method uses the protected method allocateLogicalId to render the -logical ID for an element. To modify the naming scheme, extend the Stack -class and override this method.

      -

      Parameters

      • element: CfnElement

        The CloudFormation element for which a logical identity is -needed.

        -

      Returns string

    addDependency

    • addDependency(target: Stack, reason?: string): void

    • Add a dependency between this stack and another stack.

      -

      This can be used to define dependencies between any two stacks within an -app, and also supports nested stacks.

      -

      Parameters

      • target: Stack
      • Optionalreason: string

      Returns void

    formatArn

    • formatArn(components: ArnComponents): string

    • Creates an ARN from components.

      -

      If partition, region or account are not specified, the stack's -partition, region and account will be used.

      -

      If any component is the empty string, an empty string will be inserted -into the generated ARN at the location that component corresponds to.

      -

      The ARN will be formatted as follows:

      -

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      -

      The required ARN pieces that are omitted will be taken from the stack that -the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope -can be 'undefined'.

      -

      Parameters

      • components: ArnComponents

      Returns string

    splitArn

    • splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

    • Splits the provided ARN into its components. -Works both if 'arn' is a string like 'arn:aws:s3:::bucket', -and a Token representing a dynamic CloudFormation expression -(in which case the returned components will also be dynamic CloudFormation expressions, -encoded as Tokens).

      -

      Parameters

      • arn: string

        the ARN to split into its components

        -
      • arnFormat: ArnFormat

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        -

      Returns ArnComponents

    addTransform

    • addTransform(transform: string): void

    • Add a Transform to this stack. A Transform is a macro that AWS -CloudFormation uses to process your template.

      -

      Duplicate values are removed when stack is synthesized.

      -

      Parameters

      • transform: string

        The transform to add

        -

      Returns void

      See

      https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

      -

      Example

      declare const stack: Stack;

      stack.addTransform('AWS::Serverless-2016-10-31')
-
      - -

    addMetadata

    _addAssemblyDependency

    • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
    • Internal

      Called implicitly by the addDependency helper function in order to -realize a dependency between two top-level stacks at the assembly level.

      -

      Use stack.addDependency to define the dependency between any two stacks, -and take into account nested stack relationships.

      -

      Parameters

      • target: Stack
      • Optionalreason: StackDependencyReason

      Returns void

    _obtainAssemblyDependencies

    • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
    • Internal

      Called implicitly by the obtainDependencies helper function in order to -collect resource dependencies across two top-level stacks at the assembly level.

      -

      Use stack.obtainDependencies to see the dependencies between any two stacks.

      -

      Parameters

      • reasonFilter: StackDependencyReason

      Returns Element[]

    _removeAssemblyDependency

    • _removeAssemblyDependency(
          target: Stack,
          reasonFilter?: StackDependencyReason,
      ): void
    • Internal

      Called implicitly by the removeDependency helper function in order to -remove a dependency between two top-level stacks at the assembly level.

      -

      Use stack.addDependency to define the dependency between any two stacks, -and take into account nested stack relationships.

      -

      Parameters

      • target: Stack
      • OptionalreasonFilter: StackDependencyReason

      Returns void

    _synthesizeTemplate

    • _synthesizeTemplate(
          session: ISynthesisSession,
          lookupRoleArn?: string,
          lookupRoleExternalId?: string,
          lookupRoleAdditionalOptions?: { [key: string]: any },
      ): void
    • Internal

      Synthesizes the cloudformation template into a cloud assembly.

      -

      Parameters

      • session: ISynthesisSession
      • OptionallookupRoleArn: string
      • OptionallookupRoleExternalId: string
      • OptionallookupRoleAdditionalOptions: { [key: string]: any }

      Returns void

    regionalFact

    • regionalFact(factName: string, defaultValue?: string): string

    • Look up a fact value for the given fact for the region of this stack

      -

      Will return a definite value only if the region of the current stack is resolved. -If not, a lookup map will be added to the stack and the lookup will be done at -CDK deployment time.

      -

      What regions will be included in the lookup map is controlled by the -@aws-cdk/core:target-partitions context value: it must be set to a list -of partitions, and only regions from the given partitions will be included. -If no such context key is set, all regions will be included.

      -

      This function is intended to be used by construct library authors. Application -builders can rely on the abstractions offered by construct libraries and do -not have to worry about regional facts.

      -

      If defaultValue is not given, it is an error if the fact is unknown for -the given region.

      -

      Parameters

      • factName: string
      • OptionaldefaultValue: string

      Returns string

    exportValue

    • exportValue(exportedValue: any, options?: ExportValueOptions): string

    • Create a CloudFormation Export for a string value

      -

      Returns a string representing the corresponding Fn.importValue() -expression for this Export. You can control the name for the export by -passing the name option.

      -

      If you don't supply a value for name, the value you're exporting must be -a Resource attribute (for example: bucket.bucketName) and it will be -given the same name as the automatic cross-stack reference that would be created -if you used the attribute in another Stack.

      -

      One of the uses for this method is to remove the relationship between -two Stacks established by automatic cross-stack references. It will -temporarily ensure that the CloudFormation Export still exists while you -remove the reference from the consuming stack. After that, you can remove -the resource and the manual export.

      -

      Here is how the process works. Let's say there are two stacks, -producerStack and consumerStack, and producerStack has a bucket -called bucket, which is referenced by consumerStack (perhaps because -an AWS Lambda Function writes into it, or something like that).

      -

      It is not safe to remove producerStack.bucket because as the bucket is being -deleted, consumerStack might still be using it.

      -

      Instead, the process takes two deployments:

      -

      Deployment 1: break the relationship:

      -
        -
      • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer -stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just -remove the Lambda Function altogether).
        • -
      • In the ProducerStack class, call this.exportValue(this.bucket.bucketName). This -will make sure the CloudFormation Export continues to exist while the relationship -between the two stacks is being broken.
        • -
      • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).
        • -
      -

      Deployment 2: remove the bucket resource:

      -
        -
      • You are now free to remove the bucket resource from producerStack.
        • -
      • Don't forget to remove the exportValue() call as well.
        • -
      • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
        • -
      -

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string

    exportStringListValue

    • exportStringListValue(
          exportedValue: any,
          options?: ExportValueOptions,
      ): string[]

    • Create a CloudFormation Export for a string list value

      -

      Returns a string list representing the corresponding Fn.importValue() -expression for this Export. The export expression is automatically wrapped with an -Fn::Join and the import value with an Fn::Split, since CloudFormation can only -export strings. You can control the name for the export by passing the name option.

      -

      If you don't supply a value for name, the value you're exporting must be -a Resource attribute (for example: bucket.bucketName) and it will be -given the same name as the automatic cross-stack reference that would be created -if you used the attribute in another Stack.

      -

      One of the uses for this method is to remove the relationship between -two Stacks established by automatic cross-stack references. It will -temporarily ensure that the CloudFormation Export still exists while you -remove the reference from the consuming stack. After that, you can remove -the resource and the manual export.

      -

      See exportValue for an example of this process.

      -

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string[]

    ProtectedallocateLogicalId

    • allocateLogicalId(cfnElement: CfnElement): string

    • Returns the naming scheme used to allocate logical IDs. By default, uses -the HashedAddressingScheme but this method can be overridden to customize -this behavior.

      -

      In order to make sure logical IDs are unique and stable, we hash the resource -construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as -a suffix to the path components joined without a separator (CloudFormation -IDs only allow alphanumeric characters).

      -

      The result will be:

      -

      <path.join('')><md5(path.join('/')> -"human" "hash"

      -

      If the "human" part of the ID exceeds 240 characters, we simply trim it so -the total ID doesn't exceed CloudFormation's 255 character limit.

      -

      We only take 8 characters from the md5 hash (0.000005 chance of collision).

      -

      Special cases:

      -
        -
      • If the path only contains a single component (i.e. it's a top-level -resource), we won't add the hash to it. The hash is not needed for -disambiguation and also, it allows for a more straightforward migration an -existing CloudFormation template to a CDK stack without logical ID changes -(or renames).
        • -
      • For aesthetic reasons, if the last components of the path are the same -(i.e. L1/L2/Pipeline/Pipeline), they will be de-duplicated to make the -resulting human portion of the ID more pleasing: L1L2Pipeline<HASH> -instead of L1L2PipelinePipeline<HASH>
        • -
      • If a component is named "Default" it will be omitted from the path. This -allows refactoring higher level abstractions around constructs without affecting -the IDs of already deployed resources.
        • -
      • If a component is named "Resource" it will be omitted from the user-visible -path, but included in the hash. This reduces visual noise in the human readable -part of the identifier.
        • -
      -

      Parameters

      • cfnElement: CfnElement

        The element for which the logical ID is allocated.

        -

      Returns string

    Protected_validateId

    • _validateId(name: string): void
    • Internal

      Validate stack name

      -

      CloudFormation stack names can include dashes in addition to the regular identifier -character classes, and we don't allow one of the magic markers.

      -

      Parameters

      • name: string

      Returns void

    Protected_toCloudFormation

    • _toCloudFormation(): any
    • Internal

      Returns the CloudFormation template for this stack by traversing -the tree and invoking _toCloudFormation() on all Entity objects.

      -

      Returns any

    StaticisConstruct

    • isConstruct(x: any): x is Construct

    • Checks if x is a construct.

      -

      Use this method instead of instanceof to properly detect Construct -instances, even when the construct library is symlinked.

      -

      Explanation: in JavaScript, multiple copies of the constructs library on -disk are seen as independent, completely different libraries. As a -consequence, the class Construct in each copy of the constructs library -is seen as a different class, and an instance of one class will not test as -instanceof the other class. npm install will not create installations -like this, but users may manually symlink construct libraries together or -use a monorepo tool: in those cases, multiple copies of the constructs -library can be accidentally installed, and instanceof will behave -unpredictably. It is safest to avoid using instanceof, and using -this type-testing method instead.

      -

      Parameters

      • x: any

        Any object

        -

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

      -

    toString

    • toString(): string

    • Returns a string representation of this construct.

      -

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/BuildImagePipelineStack.html b/classes/BuildImagePipelineStack.html deleted file mode 100644 index c1c38da..0000000 --- a/classes/BuildImagePipelineStack.html +++ /dev/null @@ -1,325 +0,0 @@ -BuildImagePipelineStack | aws4embeddedlinux-cdk-lib

    Class BuildImagePipelineStack

    The pipeline for building the CodeBuild Image used in other pipelines. This -will produce an image for an OS based on verified Yocto hosts.

    -

    For configuration options see BuildImagePipelineProps.

    -

    Hierarchy

    • Stack
      • BuildImagePipelineStack

    Constructors

    constructor -

    Properties

    tags -templateOptions -region -account -environment -nestedStackResource? -templateFile -artifactId -synthesizer -_versionReportingEnabled -_crossRegionReferences -_notificationArns? -node -

    Accessors

    terminationProtection -dependencies -stackName -partition -urlSuffix -stackId -notificationArns -nested -availabilityZones -nestedStackParent -bundlingRequired -

    Methods

    isStack -of -resolve -toJsonString -toYamlString -reportMissingContextKey -renameLogicalId -getLogicalId -addDependency -formatArn -splitArn -addTransform -addMetadata -_addAssemblyDependency -_obtainAssemblyDependencies -_removeAssemblyDependency -_synthesizeTemplate -regionalFact -exportValue -exportStringListValue -allocateLogicalId -_validateId -_toCloudFormation -isConstruct -toString -

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    -

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    -

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    -

    This value is resolved according to the following rules:

    -
      -
    1. The value provided to env.region when the stack is defined. This can -either be a concrete region (e.g. us-west-2) or the Aws.REGION -token.
      2. -
    2. Aws.REGION, which is represents the CloudFormation intrinsic reference -{ "Ref": "AWS::Region" } encoded as a string token.
      3. -
    -

    Preferably, you should use the return value as an opaque string and not -attempt to parse it to implement your logic. If you do, you must first -check that it is a concrete value an not an unresolved token. If this -value is an unresolved token (Token.isUnresolved(stack.region) returns -true), this implies that the user wishes that this stack will synthesize -into a region-agnostic template. In this case, your code should either -fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or -implement some other region-agnostic behavior.

    -

    Readonlyaccount

    account: string

    The AWS account into which this stack will be deployed.

    -

    This value is resolved according to the following rules:

    -
      -
    1. The value provided to env.account when the stack is defined. This can -either be a concrete account (e.g. 585695031111) or the -Aws.ACCOUNT_ID token.
      2. -
    2. Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference -{ "Ref": "AWS::AccountId" } encoded as a string token.
      3. -
    -

    Preferably, you should use the return value as an opaque string and not -attempt to parse it to implement your logic. If you do, you must first -check that it is a concrete value an not an unresolved token. If this -value is an unresolved token (Token.isUnresolved(stack.account) returns -true), this implies that the user wishes that this stack will synthesize -into a account-agnostic template. In this case, your code should either -fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or -implement some other region-agnostic behavior.

    -

    Readonlyenvironment

    environment: string

    The environment coordinates in which this stack is deployed. In the form -aws://account/region. Use stack.account and stack.region to obtain -the specific values, no need to parse.

    -

    You can use this value to determine if two stacks are targeting the same -environment.

    -

    If either stack.account or stack.region are not concrete values (e.g. -Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or -unknown-region will be used respectively to indicate this stack is -region/account-agnostic.

    -

    Optional ReadonlynestedStackResource

    nestedStackResource?: CfnResource

    If this is a nested stack, this represents its AWS::CloudFormation::Stack -resource. undefined for top-level (non-nested) stacks.

    -

    ReadonlytemplateFile

    templateFile: string

    The name of the CloudFormation template file emitted to the output -directory during synthesis.

    -

    Example value: MyStack.template.json

    -

    ReadonlyartifactId

    artifactId: string

    The ID of the cloud assembly artifact for this stack.

    -

    Readonlysynthesizer

    synthesizer: IStackSynthesizer

    Synthesis method for this stack

    -

    Readonly Internal_versionReportingEnabled

    _versionReportingEnabled: boolean

    Whether version reporting is enabled for this stack

    -

    Controls whether the CDK Metadata resource is injected

    -

    Readonly Internal_crossRegionReferences

    _crossRegionReferences: boolean

    Whether cross region references are enabled for this stack

    -

    Optional Readonly Internal_notificationArns

    _notificationArns?: string[]

    SNS Notification ARNs to receive stack events.

    -

    Readonlynode

    node: Node

    The tree node.

    -

    Accessors

    terminationProtection

    • get terminationProtection(): boolean

    • Whether termination protection is enabled for this stack.

      -

      Returns boolean

    • set terminationProtection(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    dependencies

    • get dependencies(): Stack[]

    • Return the stacks this stack depends on

      -

      Returns Stack[]

    stackName

    • get stackName(): string

    • The concrete CloudFormation physical stack name.

      -

      This is either the name defined explicitly in the stackName prop or -allocated based on the stack's location in the construct tree. Stacks that -are directly defined under the app use their construct id as their stack -name. Stacks that are defined deeper within the tree will use a hashed naming -scheme based on the construct path to ensure uniqueness.

      -

      If you wish to obtain the deploy-time AWS::StackName intrinsic, -you can use Aws.STACK_NAME directly.

      -

      Returns string

    partition

    • get partition(): string

    • The partition in which this stack is defined

      -

      Returns string

    urlSuffix

    • get urlSuffix(): string

    • The Amazon domain suffix for the region in which this stack is defined

      -

      Returns string

    stackId

    • get stackId(): string

    • The ID of the stack

      -

      Returns string

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
-
      - -

    notificationArns

    • get notificationArns(): string[]

    • Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      -

      Returns string[]

    nested

    • get nested(): boolean

    • Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      -

      Returns boolean

    availabilityZones

    • get availabilityZones(): string[]

    • Returns the list of AZs that are available in the AWS environment -(account/region) associated with this stack.

      -

      If the stack is environment-agnostic (either account and/or region are -tokens), this property will return an array with 2 tokens that will resolve -at deploy-time to the first two availability zones returned from CloudFormation's -Fn::GetAZs intrinsic function.

      -

      If they are not available in the context, returns a set of dummy values and -reports them as missing, and let the CLI resolve them by calling EC2 -DescribeAvailabilityZones on the target environment.

      -

      To specify a different strategy for selecting availability zones override this method.

      -

      Returns string[]

    nestedStackParent

    • get nestedStackParent(): undefined | Stack

    • If this is a nested stack, returns it's parent stack.

      -

      Returns undefined | Stack

    bundlingRequired

    • get bundlingRequired(): boolean

    • Indicates whether the stack requires bundling or not

      -

      Returns boolean

    Methods

    StaticisStack

    • isStack(x: any): x is Stack

    • Return whether the given object is a Stack.

      -

      We do attribute detection since we can't reliably use 'instanceof'.

      -

      Parameters

      • x: any

      Returns x is Stack

    Staticof

    • of(construct: IConstruct): Stack

    • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      -

      Parameters

      • construct: IConstruct

        The construct to start the search from.

        -

      Returns Stack

    resolve

    • resolve(obj: any): any

    • Resolve a tokenized value in the context of the current stack.

      -

      Parameters

      • obj: any

      Returns any

    toJsonString

    • toJsonString(obj: any, space?: number): string

    • Convert an object, potentially containing tokens, to a JSON string

      -

      Parameters

      • obj: any
      • Optionalspace: number

      Returns string

    toYamlString

    • toYamlString(obj: any): string

    • Convert an object, potentially containing tokens, to a YAML string

      -

      Parameters

      • obj: any

      Returns string

    reportMissingContextKey

    • reportMissingContextKey(report: MissingContext): void

    • Indicate that a context key was expected

      -

      Contains instructions which will be emitted into the cloud assembly on how -the key should be supplied.

      -

      Parameters

      • report: MissingContext

        The set of parameters needed to obtain the context

        -

      Returns void

    renameLogicalId

    • renameLogicalId(oldId: string, newId: string): void

    • Rename a generated logical identities

      -

      To modify the naming scheme strategy, extend the Stack class and -override the allocateLogicalId method.

      -

      Parameters

      • oldId: string
      • newId: string

      Returns void

    getLogicalId

    • getLogicalId(element: CfnElement): string

    • Allocates a stack-unique CloudFormation-compatible logical identity for a -specific resource.

      -

      This method is called when a CfnElement is created and used to render the -initial logical identity of resources. Logical ID renames are applied at -this stage.

      -

      This method uses the protected method allocateLogicalId to render the -logical ID for an element. To modify the naming scheme, extend the Stack -class and override this method.

      -

      Parameters

      • element: CfnElement

        The CloudFormation element for which a logical identity is -needed.

        -

      Returns string

    addDependency

    • addDependency(target: Stack, reason?: string): void

    • Add a dependency between this stack and another stack.

      -

      This can be used to define dependencies between any two stacks within an -app, and also supports nested stacks.

      -

      Parameters

      • target: Stack
      • Optionalreason: string

      Returns void

    formatArn

    • formatArn(components: ArnComponents): string

    • Creates an ARN from components.

      -

      If partition, region or account are not specified, the stack's -partition, region and account will be used.

      -

      If any component is the empty string, an empty string will be inserted -into the generated ARN at the location that component corresponds to.

      -

      The ARN will be formatted as follows:

      -

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      -

      The required ARN pieces that are omitted will be taken from the stack that -the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope -can be 'undefined'.

      -

      Parameters

      • components: ArnComponents

      Returns string

    splitArn

    • splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

    • Splits the provided ARN into its components. -Works both if 'arn' is a string like 'arn:aws:s3:::bucket', -and a Token representing a dynamic CloudFormation expression -(in which case the returned components will also be dynamic CloudFormation expressions, -encoded as Tokens).

      -

      Parameters

      • arn: string

        the ARN to split into its components

        -
      • arnFormat: ArnFormat

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        -

      Returns ArnComponents

    addTransform

    • addTransform(transform: string): void

    • Add a Transform to this stack. A Transform is a macro that AWS -CloudFormation uses to process your template.

      -

      Duplicate values are removed when stack is synthesized.

      -

      Parameters

      • transform: string

        The transform to add

        -

      Returns void

      See

      https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

      -

      Example

      declare const stack: Stack;

      stack.addTransform('AWS::Serverless-2016-10-31')
-
      - -

    addMetadata

    _addAssemblyDependency

    • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
    • Internal

      Called implicitly by the addDependency helper function in order to -realize a dependency between two top-level stacks at the assembly level.

      -

      Use stack.addDependency to define the dependency between any two stacks, -and take into account nested stack relationships.

      -

      Parameters

      • target: Stack
      • Optionalreason: StackDependencyReason

      Returns void

    _obtainAssemblyDependencies

    • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
    • Internal

      Called implicitly by the obtainDependencies helper function in order to -collect resource dependencies across two top-level stacks at the assembly level.

      -

      Use stack.obtainDependencies to see the dependencies between any two stacks.

      -

      Parameters

      • reasonFilter: StackDependencyReason

      Returns Element[]

    _removeAssemblyDependency

    • _removeAssemblyDependency(
          target: Stack,
          reasonFilter?: StackDependencyReason,
      ): void
    • Internal

      Called implicitly by the removeDependency helper function in order to -remove a dependency between two top-level stacks at the assembly level.

      -

      Use stack.addDependency to define the dependency between any two stacks, -and take into account nested stack relationships.

      -

      Parameters

      • target: Stack
      • OptionalreasonFilter: StackDependencyReason

      Returns void

    _synthesizeTemplate

    • _synthesizeTemplate(
          session: ISynthesisSession,
          lookupRoleArn?: string,
          lookupRoleExternalId?: string,
          lookupRoleAdditionalOptions?: { [key: string]: any },
      ): void
    • Internal

      Synthesizes the cloudformation template into a cloud assembly.

      -

      Parameters

      • session: ISynthesisSession
      • OptionallookupRoleArn: string
      • OptionallookupRoleExternalId: string
      • OptionallookupRoleAdditionalOptions: { [key: string]: any }

      Returns void

    regionalFact

    • regionalFact(factName: string, defaultValue?: string): string

    • Look up a fact value for the given fact for the region of this stack

      -

      Will return a definite value only if the region of the current stack is resolved. -If not, a lookup map will be added to the stack and the lookup will be done at -CDK deployment time.

      -

      What regions will be included in the lookup map is controlled by the -@aws-cdk/core:target-partitions context value: it must be set to a list -of partitions, and only regions from the given partitions will be included. -If no such context key is set, all regions will be included.

      -

      This function is intended to be used by construct library authors. Application -builders can rely on the abstractions offered by construct libraries and do -not have to worry about regional facts.

      -

      If defaultValue is not given, it is an error if the fact is unknown for -the given region.

      -

      Parameters

      • factName: string
      • OptionaldefaultValue: string

      Returns string

    exportValue

    • exportValue(exportedValue: any, options?: ExportValueOptions): string

    • Create a CloudFormation Export for a string value

      -

      Returns a string representing the corresponding Fn.importValue() -expression for this Export. You can control the name for the export by -passing the name option.

      -

      If you don't supply a value for name, the value you're exporting must be -a Resource attribute (for example: bucket.bucketName) and it will be -given the same name as the automatic cross-stack reference that would be created -if you used the attribute in another Stack.

      -

      One of the uses for this method is to remove the relationship between -two Stacks established by automatic cross-stack references. It will -temporarily ensure that the CloudFormation Export still exists while you -remove the reference from the consuming stack. After that, you can remove -the resource and the manual export.

      -

      Here is how the process works. Let's say there are two stacks, -producerStack and consumerStack, and producerStack has a bucket -called bucket, which is referenced by consumerStack (perhaps because -an AWS Lambda Function writes into it, or something like that).

      -

      It is not safe to remove producerStack.bucket because as the bucket is being -deleted, consumerStack might still be using it.

      -

      Instead, the process takes two deployments:

      -

      Deployment 1: break the relationship:

      -
        -
      • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer -stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just -remove the Lambda Function altogether).
        • -
      • In the ProducerStack class, call this.exportValue(this.bucket.bucketName). This -will make sure the CloudFormation Export continues to exist while the relationship -between the two stacks is being broken.
        • -
      • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).
        • -
      -

      Deployment 2: remove the bucket resource:

      -
        -
      • You are now free to remove the bucket resource from producerStack.
        • -
      • Don't forget to remove the exportValue() call as well.
        • -
      • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
        • -
      -

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string

    exportStringListValue

    • exportStringListValue(
          exportedValue: any,
          options?: ExportValueOptions,
      ): string[]

    • Create a CloudFormation Export for a string list value

      -

      Returns a string list representing the corresponding Fn.importValue() -expression for this Export. The export expression is automatically wrapped with an -Fn::Join and the import value with an Fn::Split, since CloudFormation can only -export strings. You can control the name for the export by passing the name option.

      -

      If you don't supply a value for name, the value you're exporting must be -a Resource attribute (for example: bucket.bucketName) and it will be -given the same name as the automatic cross-stack reference that would be created -if you used the attribute in another Stack.

      -

      One of the uses for this method is to remove the relationship between -two Stacks established by automatic cross-stack references. It will -temporarily ensure that the CloudFormation Export still exists while you -remove the reference from the consuming stack. After that, you can remove -the resource and the manual export.

      -

      See exportValue for an example of this process.

      -

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string[]

    ProtectedallocateLogicalId

    • allocateLogicalId(cfnElement: CfnElement): string

    • Returns the naming scheme used to allocate logical IDs. By default, uses -the HashedAddressingScheme but this method can be overridden to customize -this behavior.

      -

      In order to make sure logical IDs are unique and stable, we hash the resource -construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as -a suffix to the path components joined without a separator (CloudFormation -IDs only allow alphanumeric characters).

      -

      The result will be:

      -

      <path.join('')><md5(path.join('/')> -"human" "hash"

      -

      If the "human" part of the ID exceeds 240 characters, we simply trim it so -the total ID doesn't exceed CloudFormation's 255 character limit.

      -

      We only take 8 characters from the md5 hash (0.000005 chance of collision).

      -

      Special cases:

      -
        -
      • If the path only contains a single component (i.e. it's a top-level -resource), we won't add the hash to it. The hash is not needed for -disambiguation and also, it allows for a more straightforward migration an -existing CloudFormation template to a CDK stack without logical ID changes -(or renames).
        • -
      • For aesthetic reasons, if the last components of the path are the same -(i.e. L1/L2/Pipeline/Pipeline), they will be de-duplicated to make the -resulting human portion of the ID more pleasing: L1L2Pipeline<HASH> -instead of L1L2PipelinePipeline<HASH>
        • -
      • If a component is named "Default" it will be omitted from the path. This -allows refactoring higher level abstractions around constructs without affecting -the IDs of already deployed resources.
        • -
      • If a component is named "Resource" it will be omitted from the user-visible -path, but included in the hash. This reduces visual noise in the human readable -part of the identifier.
        • -
      -

      Parameters

      • cfnElement: CfnElement

        The element for which the logical ID is allocated.

        -

      Returns string

    Protected_validateId

    • _validateId(name: string): void
    • Internal

      Validate stack name

      -

      CloudFormation stack names can include dashes in addition to the regular identifier -character classes, and we don't allow one of the magic markers.

      -

      Parameters

      • name: string

      Returns void

    Protected_toCloudFormation

    • _toCloudFormation(): any
    • Internal

      Returns the CloudFormation template for this stack by traversing -the tree and invoking _toCloudFormation() on all Entity objects.

      -

      Returns any

    StaticisConstruct

    • isConstruct(x: any): x is Construct

    • Checks if x is a construct.

      -

      Use this method instead of instanceof to properly detect Construct -instances, even when the construct library is symlinked.

      -

      Explanation: in JavaScript, multiple copies of the constructs library on -disk are seen as independent, completely different libraries. As a -consequence, the class Construct in each copy of the constructs library -is seen as a different class, and an instance of one class will not test as -instanceof the other class. npm install will not create installations -like this, but users may manually symlink construct libraries together or -use a monorepo tool: in those cases, multiple copies of the constructs -library can be accidentally installed, and instanceof will behave -unpredictably. It is safest to avoid using instanceof, and using -this type-testing method instead.

      -

      Parameters

      • x: any

        Any object

        -

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

      -

    toString

    • toString(): string

    • Returns a string representation of this construct.

      -

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html deleted file mode 100644 index f8a84d5..0000000 --- a/classes/BuildImageRepoStack.html +++ /dev/null @@ -1,326 +0,0 @@ -BuildImageRepoStack | aws4embeddedlinux-cdk-lib

    Class BuildImageRepoStack

    The ECR Repository to store build host images.

    -

    This is the output of the BuildImagePipelineStack

    -

    Hierarchy

    • Stack
      • BuildImageRepoStack

    Constructors

    constructor -

    Properties

    repository -tags -templateOptions -region -account -environment -nestedStackResource? -templateFile -artifactId -synthesizer -_versionReportingEnabled -_crossRegionReferences -_notificationArns? -node -

    Accessors

    terminationProtection -dependencies -stackName -partition -urlSuffix -stackId -notificationArns -nested -availabilityZones -nestedStackParent -bundlingRequired -

    Methods

    isStack -of -resolve -toJsonString -toYamlString -reportMissingContextKey -renameLogicalId -getLogicalId -addDependency -formatArn -splitArn -addTransform -addMetadata -_addAssemblyDependency -_obtainAssemblyDependencies -_removeAssemblyDependency -_synthesizeTemplate -regionalFact -exportValue -exportStringListValue -allocateLogicalId -_validateId -_toCloudFormation -isConstruct -toString -

    Constructors

    constructor

    Properties

    Readonlyrepository

    repository: IRepository

    The respository to put the build host container in.

    -

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    -

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    -

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    -

    This value is resolved according to the following rules:

    -
      -
    1. The value provided to env.region when the stack is defined. This can -either be a concrete region (e.g. us-west-2) or the Aws.REGION -token.
      2. -
    2. Aws.REGION, which is represents the CloudFormation intrinsic reference -{ "Ref": "AWS::Region" } encoded as a string token.
      3. -
    -

    Preferably, you should use the return value as an opaque string and not -attempt to parse it to implement your logic. If you do, you must first -check that it is a concrete value an not an unresolved token. If this -value is an unresolved token (Token.isUnresolved(stack.region) returns -true), this implies that the user wishes that this stack will synthesize -into a region-agnostic template. In this case, your code should either -fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or -implement some other region-agnostic behavior.

    -

    Readonlyaccount

    account: string

    The AWS account into which this stack will be deployed.

    -

    This value is resolved according to the following rules:

    -
      -
    1. The value provided to env.account when the stack is defined. This can -either be a concrete account (e.g. 585695031111) or the -Aws.ACCOUNT_ID token.
      2. -
    2. Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference -{ "Ref": "AWS::AccountId" } encoded as a string token.
      3. -
    -

    Preferably, you should use the return value as an opaque string and not -attempt to parse it to implement your logic. If you do, you must first -check that it is a concrete value an not an unresolved token. If this -value is an unresolved token (Token.isUnresolved(stack.account) returns -true), this implies that the user wishes that this stack will synthesize -into a account-agnostic template. In this case, your code should either -fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or -implement some other region-agnostic behavior.

    -

    Readonlyenvironment

    environment: string

    The environment coordinates in which this stack is deployed. In the form -aws://account/region. Use stack.account and stack.region to obtain -the specific values, no need to parse.

    -

    You can use this value to determine if two stacks are targeting the same -environment.

    -

    If either stack.account or stack.region are not concrete values (e.g. -Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or -unknown-region will be used respectively to indicate this stack is -region/account-agnostic.

    -

    Optional ReadonlynestedStackResource

    nestedStackResource?: CfnResource

    If this is a nested stack, this represents its AWS::CloudFormation::Stack -resource. undefined for top-level (non-nested) stacks.

    -

    ReadonlytemplateFile

    templateFile: string

    The name of the CloudFormation template file emitted to the output -directory during synthesis.

    -

    Example value: MyStack.template.json

    -

    ReadonlyartifactId

    artifactId: string

    The ID of the cloud assembly artifact for this stack.

    -

    Readonlysynthesizer

    synthesizer: IStackSynthesizer

    Synthesis method for this stack

    -

    Readonly Internal_versionReportingEnabled

    _versionReportingEnabled: boolean

    Whether version reporting is enabled for this stack

    -

    Controls whether the CDK Metadata resource is injected

    -

    Readonly Internal_crossRegionReferences

    _crossRegionReferences: boolean

    Whether cross region references are enabled for this stack

    -

    Optional Readonly Internal_notificationArns

    _notificationArns?: string[]

    SNS Notification ARNs to receive stack events.

    -

    Readonlynode

    node: Node

    The tree node.

    -

    Accessors

    terminationProtection

    • get terminationProtection(): boolean

    • Whether termination protection is enabled for this stack.

      -

      Returns boolean

    • set terminationProtection(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    dependencies

    • get dependencies(): Stack[]

    • Return the stacks this stack depends on

      -

      Returns Stack[]

    stackName

    • get stackName(): string

    • The concrete CloudFormation physical stack name.

      -

      This is either the name defined explicitly in the stackName prop or -allocated based on the stack's location in the construct tree. Stacks that -are directly defined under the app use their construct id as their stack -name. Stacks that are defined deeper within the tree will use a hashed naming -scheme based on the construct path to ensure uniqueness.

      -

      If you wish to obtain the deploy-time AWS::StackName intrinsic, -you can use Aws.STACK_NAME directly.

      -

      Returns string

    partition

    • get partition(): string

    • The partition in which this stack is defined

      -

      Returns string

    urlSuffix

    • get urlSuffix(): string

    • The Amazon domain suffix for the region in which this stack is defined

      -

      Returns string

    stackId

    • get stackId(): string

    • The ID of the stack

      -

      Returns string

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
-
      - -

    notificationArns

    • get notificationArns(): string[]

    • Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      -

      Returns string[]

    nested

    • get nested(): boolean

    • Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      -

      Returns boolean

    availabilityZones

    • get availabilityZones(): string[]

    • Returns the list of AZs that are available in the AWS environment -(account/region) associated with this stack.

      -

      If the stack is environment-agnostic (either account and/or region are -tokens), this property will return an array with 2 tokens that will resolve -at deploy-time to the first two availability zones returned from CloudFormation's -Fn::GetAZs intrinsic function.

      -

      If they are not available in the context, returns a set of dummy values and -reports them as missing, and let the CLI resolve them by calling EC2 -DescribeAvailabilityZones on the target environment.

      -

      To specify a different strategy for selecting availability zones override this method.

      -

      Returns string[]

    nestedStackParent

    • get nestedStackParent(): undefined | Stack

    • If this is a nested stack, returns it's parent stack.

      -

      Returns undefined | Stack

    bundlingRequired

    • get bundlingRequired(): boolean

    • Indicates whether the stack requires bundling or not

      -

      Returns boolean

    Methods

    StaticisStack

    • isStack(x: any): x is Stack

    • Return whether the given object is a Stack.

      -

      We do attribute detection since we can't reliably use 'instanceof'.

      -

      Parameters

      • x: any

      Returns x is Stack

    Staticof

    • of(construct: IConstruct): Stack

    • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      -

      Parameters

      • construct: IConstruct

        The construct to start the search from.

        -

      Returns Stack

    resolve

    • resolve(obj: any): any

    • Resolve a tokenized value in the context of the current stack.

      -

      Parameters

      • obj: any

      Returns any

    toJsonString

    • toJsonString(obj: any, space?: number): string

    • Convert an object, potentially containing tokens, to a JSON string

      -

      Parameters

      • obj: any
      • Optionalspace: number

      Returns string

    toYamlString

    • toYamlString(obj: any): string

    • Convert an object, potentially containing tokens, to a YAML string

      -

      Parameters

      • obj: any

      Returns string

    reportMissingContextKey

    • reportMissingContextKey(report: MissingContext): void

    • Indicate that a context key was expected

      -

      Contains instructions which will be emitted into the cloud assembly on how -the key should be supplied.

      -

      Parameters

      • report: MissingContext

        The set of parameters needed to obtain the context

        -

      Returns void

    renameLogicalId

    • renameLogicalId(oldId: string, newId: string): void

    • Rename a generated logical identities

      -

      To modify the naming scheme strategy, extend the Stack class and -override the allocateLogicalId method.

      -

      Parameters

      • oldId: string
      • newId: string

      Returns void

    getLogicalId

    • getLogicalId(element: CfnElement): string

    • Allocates a stack-unique CloudFormation-compatible logical identity for a -specific resource.

      -

      This method is called when a CfnElement is created and used to render the -initial logical identity of resources. Logical ID renames are applied at -this stage.

      -

      This method uses the protected method allocateLogicalId to render the -logical ID for an element. To modify the naming scheme, extend the Stack -class and override this method.

      -

      Parameters

      • element: CfnElement

        The CloudFormation element for which a logical identity is -needed.

        -

      Returns string

    addDependency

    • addDependency(target: Stack, reason?: string): void

    • Add a dependency between this stack and another stack.

      -

      This can be used to define dependencies between any two stacks within an -app, and also supports nested stacks.

      -

      Parameters

      • target: Stack
      • Optionalreason: string

      Returns void

    formatArn

    • formatArn(components: ArnComponents): string

    • Creates an ARN from components.

      -

      If partition, region or account are not specified, the stack's -partition, region and account will be used.

      -

      If any component is the empty string, an empty string will be inserted -into the generated ARN at the location that component corresponds to.

      -

      The ARN will be formatted as follows:

      -

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      -

      The required ARN pieces that are omitted will be taken from the stack that -the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope -can be 'undefined'.

      -

      Parameters

      • components: ArnComponents

      Returns string

    splitArn

    • splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

    • Splits the provided ARN into its components. -Works both if 'arn' is a string like 'arn:aws:s3:::bucket', -and a Token representing a dynamic CloudFormation expression -(in which case the returned components will also be dynamic CloudFormation expressions, -encoded as Tokens).

      -

      Parameters

      • arn: string

        the ARN to split into its components

        -
      • arnFormat: ArnFormat

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        -

      Returns ArnComponents

    addTransform

    • addTransform(transform: string): void

    • Add a Transform to this stack. A Transform is a macro that AWS -CloudFormation uses to process your template.

      -

      Duplicate values are removed when stack is synthesized.

      -

      Parameters

      • transform: string

        The transform to add

        -

      Returns void

      See

      https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

      -

      Example

      declare const stack: Stack;

      stack.addTransform('AWS::Serverless-2016-10-31')
-
      - -

    addMetadata

    _addAssemblyDependency

    • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
    • Internal

      Called implicitly by the addDependency helper function in order to -realize a dependency between two top-level stacks at the assembly level.

      -

      Use stack.addDependency to define the dependency between any two stacks, -and take into account nested stack relationships.

      -

      Parameters

      • target: Stack
      • Optionalreason: StackDependencyReason

      Returns void

    _obtainAssemblyDependencies

    • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
    • Internal

      Called implicitly by the obtainDependencies helper function in order to -collect resource dependencies across two top-level stacks at the assembly level.

      -

      Use stack.obtainDependencies to see the dependencies between any two stacks.

      -

      Parameters

      • reasonFilter: StackDependencyReason

      Returns Element[]

    _removeAssemblyDependency

    • _removeAssemblyDependency(
          target: Stack,
          reasonFilter?: StackDependencyReason,
      ): void
    • Internal

      Called implicitly by the removeDependency helper function in order to -remove a dependency between two top-level stacks at the assembly level.

      -

      Use stack.addDependency to define the dependency between any two stacks, -and take into account nested stack relationships.

      -

      Parameters

      • target: Stack
      • OptionalreasonFilter: StackDependencyReason

      Returns void

    _synthesizeTemplate

    • _synthesizeTemplate(
          session: ISynthesisSession,
          lookupRoleArn?: string,
          lookupRoleExternalId?: string,
          lookupRoleAdditionalOptions?: { [key: string]: any },
      ): void
    • Internal

      Synthesizes the cloudformation template into a cloud assembly.

      -

      Parameters

      • session: ISynthesisSession
      • OptionallookupRoleArn: string
      • OptionallookupRoleExternalId: string
      • OptionallookupRoleAdditionalOptions: { [key: string]: any }

      Returns void

    regionalFact

    • regionalFact(factName: string, defaultValue?: string): string

    • Look up a fact value for the given fact for the region of this stack

      -

      Will return a definite value only if the region of the current stack is resolved. -If not, a lookup map will be added to the stack and the lookup will be done at -CDK deployment time.

      -

      What regions will be included in the lookup map is controlled by the -@aws-cdk/core:target-partitions context value: it must be set to a list -of partitions, and only regions from the given partitions will be included. -If no such context key is set, all regions will be included.

      -

      This function is intended to be used by construct library authors. Application -builders can rely on the abstractions offered by construct libraries and do -not have to worry about regional facts.

      -

      If defaultValue is not given, it is an error if the fact is unknown for -the given region.

      -

      Parameters

      • factName: string
      • OptionaldefaultValue: string

      Returns string

    exportValue

    • exportValue(exportedValue: any, options?: ExportValueOptions): string

    • Create a CloudFormation Export for a string value

      -

      Returns a string representing the corresponding Fn.importValue() -expression for this Export. You can control the name for the export by -passing the name option.

      -

      If you don't supply a value for name, the value you're exporting must be -a Resource attribute (for example: bucket.bucketName) and it will be -given the same name as the automatic cross-stack reference that would be created -if you used the attribute in another Stack.

      -

      One of the uses for this method is to remove the relationship between -two Stacks established by automatic cross-stack references. It will -temporarily ensure that the CloudFormation Export still exists while you -remove the reference from the consuming stack. After that, you can remove -the resource and the manual export.

      -

      Here is how the process works. Let's say there are two stacks, -producerStack and consumerStack, and producerStack has a bucket -called bucket, which is referenced by consumerStack (perhaps because -an AWS Lambda Function writes into it, or something like that).

      -

      It is not safe to remove producerStack.bucket because as the bucket is being -deleted, consumerStack might still be using it.

      -

      Instead, the process takes two deployments:

      -

      Deployment 1: break the relationship:

      -
        -
      • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer -stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just -remove the Lambda Function altogether).
        • -
      • In the ProducerStack class, call this.exportValue(this.bucket.bucketName). This -will make sure the CloudFormation Export continues to exist while the relationship -between the two stacks is being broken.
        • -
      • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).
        • -
      -

      Deployment 2: remove the bucket resource:

      -
        -
      • You are now free to remove the bucket resource from producerStack.
        • -
      • Don't forget to remove the exportValue() call as well.
        • -
      • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
        • -
      -

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string

    exportStringListValue

    • exportStringListValue(
          exportedValue: any,
          options?: ExportValueOptions,
      ): string[]

    • Create a CloudFormation Export for a string list value

      -

      Returns a string list representing the corresponding Fn.importValue() -expression for this Export. The export expression is automatically wrapped with an -Fn::Join and the import value with an Fn::Split, since CloudFormation can only -export strings. You can control the name for the export by passing the name option.

      -

      If you don't supply a value for name, the value you're exporting must be -a Resource attribute (for example: bucket.bucketName) and it will be -given the same name as the automatic cross-stack reference that would be created -if you used the attribute in another Stack.

      -

      One of the uses for this method is to remove the relationship between -two Stacks established by automatic cross-stack references. It will -temporarily ensure that the CloudFormation Export still exists while you -remove the reference from the consuming stack. After that, you can remove -the resource and the manual export.

      -

      See exportValue for an example of this process.

      -

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string[]

    ProtectedallocateLogicalId

    • allocateLogicalId(cfnElement: CfnElement): string

    • Returns the naming scheme used to allocate logical IDs. By default, uses -the HashedAddressingScheme but this method can be overridden to customize -this behavior.

      -

      In order to make sure logical IDs are unique and stable, we hash the resource -construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as -a suffix to the path components joined without a separator (CloudFormation -IDs only allow alphanumeric characters).

      -

      The result will be:

      -

      <path.join('')><md5(path.join('/')> -"human" "hash"

      -

      If the "human" part of the ID exceeds 240 characters, we simply trim it so -the total ID doesn't exceed CloudFormation's 255 character limit.

      -

      We only take 8 characters from the md5 hash (0.000005 chance of collision).

      -

      Special cases:

      -
        -
      • If the path only contains a single component (i.e. it's a top-level -resource), we won't add the hash to it. The hash is not needed for -disambiguation and also, it allows for a more straightforward migration an -existing CloudFormation template to a CDK stack without logical ID changes -(or renames).
        • -
      • For aesthetic reasons, if the last components of the path are the same -(i.e. L1/L2/Pipeline/Pipeline), they will be de-duplicated to make the -resulting human portion of the ID more pleasing: L1L2Pipeline<HASH> -instead of L1L2PipelinePipeline<HASH>
        • -
      • If a component is named "Default" it will be omitted from the path. This -allows refactoring higher level abstractions around constructs without affecting -the IDs of already deployed resources.
        • -
      • If a component is named "Resource" it will be omitted from the user-visible -path, but included in the hash. This reduces visual noise in the human readable -part of the identifier.
        • -
      -

      Parameters

      • cfnElement: CfnElement

        The element for which the logical ID is allocated.

        -

      Returns string

    Protected_validateId

    • _validateId(name: string): void
    • Internal

      Validate stack name

      -

      CloudFormation stack names can include dashes in addition to the regular identifier -character classes, and we don't allow one of the magic markers.

      -

      Parameters

      • name: string

      Returns void

    Protected_toCloudFormation

    • _toCloudFormation(): any
    • Internal

      Returns the CloudFormation template for this stack by traversing -the tree and invoking _toCloudFormation() on all Entity objects.

      -

      Returns any

    StaticisConstruct

    • isConstruct(x: any): x is Construct

    • Checks if x is a construct.

      -

      Use this method instead of instanceof to properly detect Construct -instances, even when the construct library is symlinked.

      -

      Explanation: in JavaScript, multiple copies of the constructs library on -disk are seen as independent, completely different libraries. As a -consequence, the class Construct in each copy of the constructs library -is seen as a different class, and an instance of one class will not test as -instanceof the other class. npm install will not create installations -like this, but users may manually symlink construct libraries together or -use a monorepo tool: in those cases, multiple copies of the constructs -library can be accidentally installed, and instanceof will behave -unpredictably. It is safest to avoid using instanceof, and using -this type-testing method instead.

      -

      Parameters

      • x: any

        Any object

        -

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

      -

    toString

    • toString(): string

    • Returns a string representation of this construct.

      -

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html new file mode 100644 index 0000000..2cdea17 --- /dev/null +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -0,0 +1,324 @@ +EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib

    Class EmbeddedLinuxCodeBuildProjectStack

    The stack for creating a build pipeline.

    +

    See EmbeddedLinuxCodeBuildProjectProps for configration options.

    +

    Hierarchy

    • Stack
      • EmbeddedLinuxCodeBuildProjectStack

    Constructors

    constructor +

    Properties

    tags +templateOptions +region +account +environment +nestedStackResource? +templateFile +artifactId +synthesizer +_versionReportingEnabled +_crossRegionReferences +_notificationArns? +node +

    Accessors

    terminationProtection +dependencies +stackName +partition +urlSuffix +stackId +notificationArns +nested +availabilityZones +nestedStackParent +bundlingRequired +

    Methods

    isStack +of +resolve +toJsonString +toYamlString +reportMissingContextKey +renameLogicalId +getLogicalId +addDependency +formatArn +splitArn +addTransform +addMetadata +_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate +regionalFact +exportValue +exportStringListValue +allocateLogicalId +_validateId +_toCloudFormation +isConstruct +toString +

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    +

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    +

    This value is resolved according to the following rules:

    +
      +
    1. The value provided to env.region when the stack is defined. This can +either be a concrete region (e.g. us-west-2) or the Aws.REGION +token.
      2. +
    2. Aws.REGION, which is represents the CloudFormation intrinsic reference +{ "Ref": "AWS::Region" } encoded as a string token.
      3. +
    +

    Preferably, you should use the return value as an opaque string and not +attempt to parse it to implement your logic. If you do, you must first +check that it is a concrete value an not an unresolved token. If this +value is an unresolved token (Token.isUnresolved(stack.region) returns +true), this implies that the user wishes that this stack will synthesize +into a region-agnostic template. In this case, your code should either +fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or +implement some other region-agnostic behavior.

    +

    Readonlyaccount

    account: string

    The AWS account into which this stack will be deployed.

    +

    This value is resolved according to the following rules:

    +
      +
    1. The value provided to env.account when the stack is defined. This can +either be a concrete account (e.g. 585695031111) or the +Aws.ACCOUNT_ID token.
      2. +
    2. Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference +{ "Ref": "AWS::AccountId" } encoded as a string token.
      3. +
    +

    Preferably, you should use the return value as an opaque string and not +attempt to parse it to implement your logic. If you do, you must first +check that it is a concrete value an not an unresolved token. If this +value is an unresolved token (Token.isUnresolved(stack.account) returns +true), this implies that the user wishes that this stack will synthesize +into a account-agnostic template. In this case, your code should either +fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or +implement some other region-agnostic behavior.

    +

    Readonlyenvironment

    environment: string

    The environment coordinates in which this stack is deployed. In the form +aws://account/region. Use stack.account and stack.region to obtain +the specific values, no need to parse.

    +

    You can use this value to determine if two stacks are targeting the same +environment.

    +

    If either stack.account or stack.region are not concrete values (e.g. +Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or +unknown-region will be used respectively to indicate this stack is +region/account-agnostic.

    +

    Optional ReadonlynestedStackResource

    nestedStackResource?: CfnResource

    If this is a nested stack, this represents its AWS::CloudFormation::Stack +resource. undefined for top-level (non-nested) stacks.

    +

    ReadonlytemplateFile

    templateFile: string

    The name of the CloudFormation template file emitted to the output +directory during synthesis.

    +

    Example value: MyStack.template.json

    +

    ReadonlyartifactId

    artifactId: string

    The ID of the cloud assembly artifact for this stack.

    +

    Readonlysynthesizer

    synthesizer: IStackSynthesizer

    Synthesis method for this stack

    +

    Readonly Internal_versionReportingEnabled

    _versionReportingEnabled: boolean

    Whether version reporting is enabled for this stack

    +

    Controls whether the CDK Metadata resource is injected

    +

    Readonly Internal_crossRegionReferences

    _crossRegionReferences: boolean

    Whether cross region references are enabled for this stack

    +

    Optional Readonly Internal_notificationArns

    _notificationArns?: string[]

    SNS Notification ARNs to receive stack events.

    +

    Readonlynode

    node: Node

    The tree node.

    +

    Accessors

    terminationProtection

    • get terminationProtection(): boolean

      Whether termination protection is enabled for this stack.

      +

      Returns boolean

    • set terminationProtection(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    dependencies

    • get dependencies(): Stack[]

      Return the stacks this stack depends on

      +

      Returns Stack[]

    stackName

    • get stackName(): string

      The concrete CloudFormation physical stack name.

      +

      This is either the name defined explicitly in the stackName prop or +allocated based on the stack's location in the construct tree. Stacks that +are directly defined under the app use their construct id as their stack +name. Stacks that are defined deeper within the tree will use a hashed naming +scheme based on the construct path to ensure uniqueness.

      +

      If you wish to obtain the deploy-time AWS::StackName intrinsic, +you can use Aws.STACK_NAME directly.

      +

      Returns string

    partition

    • get partition(): string

      The partition in which this stack is defined

      +

      Returns string

    urlSuffix

    • get urlSuffix(): string

      The Amazon domain suffix for the region in which this stack is defined

      +

      Returns string

    stackId

    • get stackId(): string

      The ID of the stack

      +

      Returns string

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+
      + +

    notificationArns

    • get notificationArns(): string[]

      Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      +

      Returns string[]

    nested

    • get nested(): boolean

      Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      +

      Returns boolean

    availabilityZones

    • get availabilityZones(): string[]

      Returns the list of AZs that are available in the AWS environment +(account/region) associated with this stack.

      +

      If the stack is environment-agnostic (either account and/or region are +tokens), this property will return an array with 2 tokens that will resolve +at deploy-time to the first two availability zones returned from CloudFormation's +Fn::GetAZs intrinsic function.

      +

      If they are not available in the context, returns a set of dummy values and +reports them as missing, and let the CLI resolve them by calling EC2 +DescribeAvailabilityZones on the target environment.

      +

      To specify a different strategy for selecting availability zones override this method.

      +

      Returns string[]

    nestedStackParent

    • get nestedStackParent(): undefined | Stack

      If this is a nested stack, returns it's parent stack.

      +

      Returns undefined | Stack

    bundlingRequired

    • get bundlingRequired(): boolean

      Indicates whether the stack requires bundling or not

      +

      Returns boolean

    Methods

    StaticisStack

    • isStack(x: any): x is Stack

      Return whether the given object is a Stack.

      +

      We do attribute detection since we can't reliably use 'instanceof'.

      +

      Parameters

      • x: any

      Returns x is Stack

    Staticof

    • of(construct: IConstruct): Stack

      Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      +

      Parameters

      • construct: IConstruct

        The construct to start the search from.

        +

      Returns Stack

    resolve

    • resolve(obj: any): any

      Resolve a tokenized value in the context of the current stack.

      +

      Parameters

      • obj: any

      Returns any

    toJsonString

    • toJsonString(obj: any, space?: number): string

      Convert an object, potentially containing tokens, to a JSON string

      +

      Parameters

      • obj: any
      • Optionalspace: number

      Returns string

    toYamlString

    • toYamlString(obj: any): string

      Convert an object, potentially containing tokens, to a YAML string

      +

      Parameters

      • obj: any

      Returns string

    reportMissingContextKey

    • reportMissingContextKey(report: MissingContext): void

      Indicate that a context key was expected

      +

      Contains instructions which will be emitted into the cloud assembly on how +the key should be supplied.

      +

      Parameters

      • report: MissingContext

        The set of parameters needed to obtain the context

        +

      Returns void

    renameLogicalId

    • renameLogicalId(oldId: string, newId: string): void

      Rename a generated logical identities

      +

      To modify the naming scheme strategy, extend the Stack class and +override the allocateLogicalId method.

      +

      Parameters

      • oldId: string
      • newId: string

      Returns void

    getLogicalId

    • getLogicalId(element: CfnElement): string

      Allocates a stack-unique CloudFormation-compatible logical identity for a +specific resource.

      +

      This method is called when a CfnElement is created and used to render the +initial logical identity of resources. Logical ID renames are applied at +this stage.

      +

      This method uses the protected method allocateLogicalId to render the +logical ID for an element. To modify the naming scheme, extend the Stack +class and override this method.

      +

      Parameters

      • element: CfnElement

        The CloudFormation element for which a logical identity is +needed.

        +

      Returns string

    addDependency

    • addDependency(target: Stack, reason?: string): void

      Add a dependency between this stack and another stack.

      +

      This can be used to define dependencies between any two stacks within an +app, and also supports nested stacks.

      +

      Parameters

      • target: Stack
      • Optionalreason: string

      Returns void

    formatArn

    • formatArn(components: ArnComponents): string

      Creates an ARN from components.

      +

      If partition, region or account are not specified, the stack's +partition, region and account will be used.

      +

      If any component is the empty string, an empty string will be inserted +into the generated ARN at the location that component corresponds to.

      +

      The ARN will be formatted as follows:

      +

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      +

      The required ARN pieces that are omitted will be taken from the stack that +the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope +can be 'undefined'.

      +

      Parameters

      • components: ArnComponents

      Returns string

    splitArn

    • splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

      Splits the provided ARN into its components. +Works both if 'arn' is a string like 'arn:aws:s3:::bucket', +and a Token representing a dynamic CloudFormation expression +(in which case the returned components will also be dynamic CloudFormation expressions, +encoded as Tokens).

      +

      Parameters

      • arn: string

        the ARN to split into its components

        +
      • arnFormat: ArnFormat

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        +

      Returns ArnComponents

    addTransform

    • addTransform(transform: string): void

      Add a Transform to this stack. A Transform is a macro that AWS +CloudFormation uses to process your template.

      +

      Duplicate values are removed when stack is synthesized.

      +

      Parameters

      • transform: string

        The transform to add

        +

      Returns void

      See

      https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

      +

      Example

      declare const stack: Stack;

      stack.addTransform('AWS::Serverless-2016-10-31')
+
      + +

    addMetadata

    _addAssemblyDependency

    • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
      Internal

      Called implicitly by the addDependency helper function in order to +realize a dependency between two top-level stacks at the assembly level.

      +

      Use stack.addDependency to define the dependency between any two stacks, +and take into account nested stack relationships.

      +

      Parameters

      • target: Stack
      • Optionalreason: StackDependencyReason

      Returns void

    _obtainAssemblyDependencies

    • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
      Internal

      Called implicitly by the obtainDependencies helper function in order to +collect resource dependencies across two top-level stacks at the assembly level.

      +

      Use stack.obtainDependencies to see the dependencies between any two stacks.

      +

      Parameters

      • reasonFilter: StackDependencyReason

      Returns Element[]

    _removeAssemblyDependency

    • _removeAssemblyDependency(
          target: Stack,
          reasonFilter?: StackDependencyReason,
      ): void
      Internal

      Called implicitly by the removeDependency helper function in order to +remove a dependency between two top-level stacks at the assembly level.

      +

      Use stack.addDependency to define the dependency between any two stacks, +and take into account nested stack relationships.

      +

      Parameters

      • target: Stack
      • OptionalreasonFilter: StackDependencyReason

      Returns void

    _synthesizeTemplate

    • _synthesizeTemplate(
          session: ISynthesisSession,
          lookupRoleArn?: string,
          lookupRoleExternalId?: string,
          lookupRoleAdditionalOptions?: { [key: string]: any },
      ): void
      Internal

      Synthesizes the cloudformation template into a cloud assembly.

      +

      Parameters

      • session: ISynthesisSession
      • OptionallookupRoleArn: string
      • OptionallookupRoleExternalId: string
      • OptionallookupRoleAdditionalOptions: { [key: string]: any }

      Returns void

    regionalFact

    • regionalFact(factName: string, defaultValue?: string): string

      Look up a fact value for the given fact for the region of this stack

      +

      Will return a definite value only if the region of the current stack is resolved. +If not, a lookup map will be added to the stack and the lookup will be done at +CDK deployment time.

      +

      What regions will be included in the lookup map is controlled by the +@aws-cdk/core:target-partitions context value: it must be set to a list +of partitions, and only regions from the given partitions will be included. +If no such context key is set, all regions will be included.

      +

      This function is intended to be used by construct library authors. Application +builders can rely on the abstractions offered by construct libraries and do +not have to worry about regional facts.

      +

      If defaultValue is not given, it is an error if the fact is unknown for +the given region.

      +

      Parameters

      • factName: string
      • OptionaldefaultValue: string

      Returns string

    exportValue

    • exportValue(exportedValue: any, options?: ExportValueOptions): string

      Create a CloudFormation Export for a string value

      +

      Returns a string representing the corresponding Fn.importValue() +expression for this Export. You can control the name for the export by +passing the name option.

      +

      If you don't supply a value for name, the value you're exporting must be +a Resource attribute (for example: bucket.bucketName) and it will be +given the same name as the automatic cross-stack reference that would be created +if you used the attribute in another Stack.

      +

      One of the uses for this method is to remove the relationship between +two Stacks established by automatic cross-stack references. It will +temporarily ensure that the CloudFormation Export still exists while you +remove the reference from the consuming stack. After that, you can remove +the resource and the manual export.

      +

      Here is how the process works. Let's say there are two stacks, +producerStack and consumerStack, and producerStack has a bucket +called bucket, which is referenced by consumerStack (perhaps because +an AWS Lambda Function writes into it, or something like that).

      +

      It is not safe to remove producerStack.bucket because as the bucket is being +deleted, consumerStack might still be using it.

      +

      Instead, the process takes two deployments:

      +

      Deployment 1: break the relationship:

      +
        +
      • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer +stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just +remove the Lambda Function altogether).
        • +
      • In the ProducerStack class, call this.exportValue(this.bucket.bucketName). This +will make sure the CloudFormation Export continues to exist while the relationship +between the two stacks is being broken.
        • +
      • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).
        • +
      +

      Deployment 2: remove the bucket resource:

      +
        +
      • You are now free to remove the bucket resource from producerStack.
        • +
      • Don't forget to remove the exportValue() call as well.
        • +
      • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
        • +
      +

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string

    exportStringListValue

    • exportStringListValue(
          exportedValue: any,
          options?: ExportValueOptions,
      ): string[]

      Create a CloudFormation Export for a string list value

      +

      Returns a string list representing the corresponding Fn.importValue() +expression for this Export. The export expression is automatically wrapped with an +Fn::Join and the import value with an Fn::Split, since CloudFormation can only +export strings. You can control the name for the export by passing the name option.

      +

      If you don't supply a value for name, the value you're exporting must be +a Resource attribute (for example: bucket.bucketName) and it will be +given the same name as the automatic cross-stack reference that would be created +if you used the attribute in another Stack.

      +

      One of the uses for this method is to remove the relationship between +two Stacks established by automatic cross-stack references. It will +temporarily ensure that the CloudFormation Export still exists while you +remove the reference from the consuming stack. After that, you can remove +the resource and the manual export.

      +

      See exportValue for an example of this process.

      +

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string[]

    ProtectedallocateLogicalId

    • allocateLogicalId(cfnElement: CfnElement): string

      Returns the naming scheme used to allocate logical IDs. By default, uses +the HashedAddressingScheme but this method can be overridden to customize +this behavior.

      +

      In order to make sure logical IDs are unique and stable, we hash the resource +construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as +a suffix to the path components joined without a separator (CloudFormation +IDs only allow alphanumeric characters).

      +

      The result will be:

      +

      <path.join('')><md5(path.join('/')> +"human" "hash"

      +

      If the "human" part of the ID exceeds 240 characters, we simply trim it so +the total ID doesn't exceed CloudFormation's 255 character limit.

      +

      We only take 8 characters from the md5 hash (0.000005 chance of collision).

      +

      Special cases:

      +
        +
      • If the path only contains a single component (i.e. it's a top-level +resource), we won't add the hash to it. The hash is not needed for +disambiguation and also, it allows for a more straightforward migration an +existing CloudFormation template to a CDK stack without logical ID changes +(or renames).
        • +
      • For aesthetic reasons, if the last components of the path are the same +(i.e. L1/L2/Pipeline/Pipeline), they will be de-duplicated to make the +resulting human portion of the ID more pleasing: L1L2Pipeline<HASH> +instead of L1L2PipelinePipeline<HASH>
        • +
      • If a component is named "Default" it will be omitted from the path. This +allows refactoring higher level abstractions around constructs without affecting +the IDs of already deployed resources.
        • +
      • If a component is named "Resource" it will be omitted from the user-visible +path, but included in the hash. This reduces visual noise in the human readable +part of the identifier.
        • +
      +

      Parameters

      • cfnElement: CfnElement

        The element for which the logical ID is allocated.

        +

      Returns string

    Protected_validateId

    • _validateId(name: string): void
      Internal

      Validate stack name

      +

      CloudFormation stack names can include dashes in addition to the regular identifier +character classes, and we don't allow one of the magic markers.

      +

      Parameters

      • name: string

      Returns void

    Protected_toCloudFormation

    • _toCloudFormation(): any
      Internal

      Returns the CloudFormation template for this stack by traversing +the tree and invoking _toCloudFormation() on all Entity objects.

      +

      Returns any

    StaticisConstruct

    • isConstruct(x: any): x is Construct

      Checks if x is a construct.

      +

      Use this method instead of instanceof to properly detect Construct +instances, even when the construct library is symlinked.

      +

      Explanation: in JavaScript, multiple copies of the constructs library on +disk are seen as independent, completely different libraries. As a +consequence, the class Construct in each copy of the constructs library +is seen as a different class, and an instance of one class will not test as +instanceof the other class. npm install will not create installations +like this, but users may manually symlink construct libraries together or +use a monorepo tool: in those cases, multiple copies of the constructs +library can be accidentally installed, and instanceof will behave +unpredictably. It is safest to avoid using instanceof, and using +this type-testing method instead.

      +

      Parameters

      • x: any

        Any object

        +

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

      +

    toString

    • toString(): string

      Returns a string representation of this construct.

      +

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html new file mode 100644 index 0000000..f3734e7 --- /dev/null +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -0,0 +1,329 @@ +EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib

    Class EmbeddedLinuxCodePipelineBaseImageStack

    The pipeline for building the CodeBuild Image used in other pipelines. This +will produce an image for an OS based on verified Yocto hosts.

    +

    For configuration options see BuildBaseImageCodePipelineProps.

    +

    Hierarchy

    • Stack
      • EmbeddedLinuxCodePipelineBaseImageStack

    Constructors

    constructor +

    Properties

    ecrRepository +ecrRepositoryImageTag +tags +templateOptions +region +account +environment +nestedStackResource? +templateFile +artifactId +synthesizer +_versionReportingEnabled +_crossRegionReferences +_notificationArns? +node +

    Accessors

    terminationProtection +dependencies +stackName +partition +urlSuffix +stackId +notificationArns +nested +availabilityZones +nestedStackParent +bundlingRequired +

    Methods

    isStack +of +resolve +toJsonString +toYamlString +reportMissingContextKey +renameLogicalId +getLogicalId +addDependency +formatArn +splitArn +addTransform +addMetadata +_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate +regionalFact +exportValue +exportStringListValue +allocateLogicalId +_validateId +_toCloudFormation +isConstruct +toString +

    Constructors

    constructor

    Properties

    ReadonlyecrRepository

    ecrRepository: IRepository

    The ECR Repository where the image is located.

    +

    ReadonlyecrRepositoryImageTag

    ecrRepositoryImageTag: string

    The ECR Image Tag to find the base imaged.

    +

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    +

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    +

    This value is resolved according to the following rules:

    +
      +
    1. The value provided to env.region when the stack is defined. This can +either be a concrete region (e.g. us-west-2) or the Aws.REGION +token.
      2. +
    2. Aws.REGION, which is represents the CloudFormation intrinsic reference +{ "Ref": "AWS::Region" } encoded as a string token.
      3. +
    +

    Preferably, you should use the return value as an opaque string and not +attempt to parse it to implement your logic. If you do, you must first +check that it is a concrete value an not an unresolved token. If this +value is an unresolved token (Token.isUnresolved(stack.region) returns +true), this implies that the user wishes that this stack will synthesize +into a region-agnostic template. In this case, your code should either +fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or +implement some other region-agnostic behavior.

    +

    Readonlyaccount

    account: string

    The AWS account into which this stack will be deployed.

    +

    This value is resolved according to the following rules:

    +
      +
    1. The value provided to env.account when the stack is defined. This can +either be a concrete account (e.g. 585695031111) or the +Aws.ACCOUNT_ID token.
      2. +
    2. Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference +{ "Ref": "AWS::AccountId" } encoded as a string token.
      3. +
    +

    Preferably, you should use the return value as an opaque string and not +attempt to parse it to implement your logic. If you do, you must first +check that it is a concrete value an not an unresolved token. If this +value is an unresolved token (Token.isUnresolved(stack.account) returns +true), this implies that the user wishes that this stack will synthesize +into a account-agnostic template. In this case, your code should either +fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or +implement some other region-agnostic behavior.

    +

    Readonlyenvironment

    environment: string

    The environment coordinates in which this stack is deployed. In the form +aws://account/region. Use stack.account and stack.region to obtain +the specific values, no need to parse.

    +

    You can use this value to determine if two stacks are targeting the same +environment.

    +

    If either stack.account or stack.region are not concrete values (e.g. +Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or +unknown-region will be used respectively to indicate this stack is +region/account-agnostic.

    +

    Optional ReadonlynestedStackResource

    nestedStackResource?: CfnResource

    If this is a nested stack, this represents its AWS::CloudFormation::Stack +resource. undefined for top-level (non-nested) stacks.

    +

    ReadonlytemplateFile

    templateFile: string

    The name of the CloudFormation template file emitted to the output +directory during synthesis.

    +

    Example value: MyStack.template.json

    +

    ReadonlyartifactId

    artifactId: string

    The ID of the cloud assembly artifact for this stack.

    +

    Readonlysynthesizer

    synthesizer: IStackSynthesizer

    Synthesis method for this stack

    +

    Readonly Internal_versionReportingEnabled

    _versionReportingEnabled: boolean

    Whether version reporting is enabled for this stack

    +

    Controls whether the CDK Metadata resource is injected

    +

    Readonly Internal_crossRegionReferences

    _crossRegionReferences: boolean

    Whether cross region references are enabled for this stack

    +

    Optional Readonly Internal_notificationArns

    _notificationArns?: string[]

    SNS Notification ARNs to receive stack events.

    +

    Readonlynode

    node: Node

    The tree node.

    +

    Accessors

    terminationProtection

    • get terminationProtection(): boolean

      Whether termination protection is enabled for this stack.

      +

      Returns boolean

    • set terminationProtection(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    dependencies

    • get dependencies(): Stack[]

      Return the stacks this stack depends on

      +

      Returns Stack[]

    stackName

    • get stackName(): string

      The concrete CloudFormation physical stack name.

      +

      This is either the name defined explicitly in the stackName prop or +allocated based on the stack's location in the construct tree. Stacks that +are directly defined under the app use their construct id as their stack +name. Stacks that are defined deeper within the tree will use a hashed naming +scheme based on the construct path to ensure uniqueness.

      +

      If you wish to obtain the deploy-time AWS::StackName intrinsic, +you can use Aws.STACK_NAME directly.

      +

      Returns string

    partition

    • get partition(): string

      The partition in which this stack is defined

      +

      Returns string

    urlSuffix

    • get urlSuffix(): string

      The Amazon domain suffix for the region in which this stack is defined

      +

      Returns string

    stackId

    • get stackId(): string

      The ID of the stack

      +

      Returns string

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+
      + +

    notificationArns

    • get notificationArns(): string[]

      Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      +

      Returns string[]

    nested

    • get nested(): boolean

      Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      +

      Returns boolean

    availabilityZones

    • get availabilityZones(): string[]

      Returns the list of AZs that are available in the AWS environment +(account/region) associated with this stack.

      +

      If the stack is environment-agnostic (either account and/or region are +tokens), this property will return an array with 2 tokens that will resolve +at deploy-time to the first two availability zones returned from CloudFormation's +Fn::GetAZs intrinsic function.

      +

      If they are not available in the context, returns a set of dummy values and +reports them as missing, and let the CLI resolve them by calling EC2 +DescribeAvailabilityZones on the target environment.

      +

      To specify a different strategy for selecting availability zones override this method.

      +

      Returns string[]

    nestedStackParent

    • get nestedStackParent(): undefined | Stack

      If this is a nested stack, returns it's parent stack.

      +

      Returns undefined | Stack

    bundlingRequired

    • get bundlingRequired(): boolean

      Indicates whether the stack requires bundling or not

      +

      Returns boolean

    Methods

    StaticisStack

    • isStack(x: any): x is Stack

      Return whether the given object is a Stack.

      +

      We do attribute detection since we can't reliably use 'instanceof'.

      +

      Parameters

      • x: any

      Returns x is Stack

    Staticof

    • of(construct: IConstruct): Stack

      Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      +

      Parameters

      • construct: IConstruct

        The construct to start the search from.

        +

      Returns Stack

    resolve

    • resolve(obj: any): any

      Resolve a tokenized value in the context of the current stack.

      +

      Parameters

      • obj: any

      Returns any

    toJsonString

    • toJsonString(obj: any, space?: number): string

      Convert an object, potentially containing tokens, to a JSON string

      +

      Parameters

      • obj: any
      • Optionalspace: number

      Returns string

    toYamlString

    • toYamlString(obj: any): string

      Convert an object, potentially containing tokens, to a YAML string

      +

      Parameters

      • obj: any

      Returns string

    reportMissingContextKey

    • reportMissingContextKey(report: MissingContext): void

      Indicate that a context key was expected

      +

      Contains instructions which will be emitted into the cloud assembly on how +the key should be supplied.

      +

      Parameters

      • report: MissingContext

        The set of parameters needed to obtain the context

        +

      Returns void

    renameLogicalId

    • renameLogicalId(oldId: string, newId: string): void

      Rename a generated logical identities

      +

      To modify the naming scheme strategy, extend the Stack class and +override the allocateLogicalId method.

      +

      Parameters

      • oldId: string
      • newId: string

      Returns void

    getLogicalId

    • getLogicalId(element: CfnElement): string

      Allocates a stack-unique CloudFormation-compatible logical identity for a +specific resource.

      +

      This method is called when a CfnElement is created and used to render the +initial logical identity of resources. Logical ID renames are applied at +this stage.

      +

      This method uses the protected method allocateLogicalId to render the +logical ID for an element. To modify the naming scheme, extend the Stack +class and override this method.

      +

      Parameters

      • element: CfnElement

        The CloudFormation element for which a logical identity is +needed.

        +

      Returns string

    addDependency

    • addDependency(target: Stack, reason?: string): void

      Add a dependency between this stack and another stack.

      +

      This can be used to define dependencies between any two stacks within an +app, and also supports nested stacks.

      +

      Parameters

      • target: Stack
      • Optionalreason: string

      Returns void

    formatArn

    • formatArn(components: ArnComponents): string

      Creates an ARN from components.

      +

      If partition, region or account are not specified, the stack's +partition, region and account will be used.

      +

      If any component is the empty string, an empty string will be inserted +into the generated ARN at the location that component corresponds to.

      +

      The ARN will be formatted as follows:

      +

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      +

      The required ARN pieces that are omitted will be taken from the stack that +the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope +can be 'undefined'.

      +

      Parameters

      • components: ArnComponents

      Returns string

    splitArn

    • splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

      Splits the provided ARN into its components. +Works both if 'arn' is a string like 'arn:aws:s3:::bucket', +and a Token representing a dynamic CloudFormation expression +(in which case the returned components will also be dynamic CloudFormation expressions, +encoded as Tokens).

      +

      Parameters

      • arn: string

        the ARN to split into its components

        +
      • arnFormat: ArnFormat

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        +

      Returns ArnComponents

    addTransform

    • addTransform(transform: string): void

      Add a Transform to this stack. A Transform is a macro that AWS +CloudFormation uses to process your template.

      +

      Duplicate values are removed when stack is synthesized.

      +

      Parameters

      • transform: string

        The transform to add

        +

      Returns void

      See

      https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

      +

      Example

      declare const stack: Stack;

      stack.addTransform('AWS::Serverless-2016-10-31')
+
      + +

    addMetadata

    _addAssemblyDependency

    • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
      Internal

      Called implicitly by the addDependency helper function in order to +realize a dependency between two top-level stacks at the assembly level.

      +

      Use stack.addDependency to define the dependency between any two stacks, +and take into account nested stack relationships.

      +

      Parameters

      • target: Stack
      • Optionalreason: StackDependencyReason

      Returns void

    _obtainAssemblyDependencies

    • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
      Internal

      Called implicitly by the obtainDependencies helper function in order to +collect resource dependencies across two top-level stacks at the assembly level.

      +

      Use stack.obtainDependencies to see the dependencies between any two stacks.

      +

      Parameters

      • reasonFilter: StackDependencyReason

      Returns Element[]

    _removeAssemblyDependency

    • _removeAssemblyDependency(
          target: Stack,
          reasonFilter?: StackDependencyReason,
      ): void
      Internal

      Called implicitly by the removeDependency helper function in order to +remove a dependency between two top-level stacks at the assembly level.

      +

      Use stack.addDependency to define the dependency between any two stacks, +and take into account nested stack relationships.

      +

      Parameters

      • target: Stack
      • OptionalreasonFilter: StackDependencyReason

      Returns void

    _synthesizeTemplate

    • _synthesizeTemplate(
          session: ISynthesisSession,
          lookupRoleArn?: string,
          lookupRoleExternalId?: string,
          lookupRoleAdditionalOptions?: { [key: string]: any },
      ): void
      Internal

      Synthesizes the cloudformation template into a cloud assembly.

      +

      Parameters

      • session: ISynthesisSession
      • OptionallookupRoleArn: string
      • OptionallookupRoleExternalId: string
      • OptionallookupRoleAdditionalOptions: { [key: string]: any }

      Returns void

    regionalFact

    • regionalFact(factName: string, defaultValue?: string): string

      Look up a fact value for the given fact for the region of this stack

      +

      Will return a definite value only if the region of the current stack is resolved. +If not, a lookup map will be added to the stack and the lookup will be done at +CDK deployment time.

      +

      What regions will be included in the lookup map is controlled by the +@aws-cdk/core:target-partitions context value: it must be set to a list +of partitions, and only regions from the given partitions will be included. +If no such context key is set, all regions will be included.

      +

      This function is intended to be used by construct library authors. Application +builders can rely on the abstractions offered by construct libraries and do +not have to worry about regional facts.

      +

      If defaultValue is not given, it is an error if the fact is unknown for +the given region.

      +

      Parameters

      • factName: string
      • OptionaldefaultValue: string

      Returns string

    exportValue

    • exportValue(exportedValue: any, options?: ExportValueOptions): string

      Create a CloudFormation Export for a string value

      +

      Returns a string representing the corresponding Fn.importValue() +expression for this Export. You can control the name for the export by +passing the name option.

      +

      If you don't supply a value for name, the value you're exporting must be +a Resource attribute (for example: bucket.bucketName) and it will be +given the same name as the automatic cross-stack reference that would be created +if you used the attribute in another Stack.

      +

      One of the uses for this method is to remove the relationship between +two Stacks established by automatic cross-stack references. It will +temporarily ensure that the CloudFormation Export still exists while you +remove the reference from the consuming stack. After that, you can remove +the resource and the manual export.

      +

      Here is how the process works. Let's say there are two stacks, +producerStack and consumerStack, and producerStack has a bucket +called bucket, which is referenced by consumerStack (perhaps because +an AWS Lambda Function writes into it, or something like that).

      +

      It is not safe to remove producerStack.bucket because as the bucket is being +deleted, consumerStack might still be using it.

      +

      Instead, the process takes two deployments:

      +

      Deployment 1: break the relationship:

      +
        +
      • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer +stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just +remove the Lambda Function altogether).
        • +
      • In the ProducerStack class, call this.exportValue(this.bucket.bucketName). This +will make sure the CloudFormation Export continues to exist while the relationship +between the two stacks is being broken.
        • +
      • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).
        • +
      +

      Deployment 2: remove the bucket resource:

      +
        +
      • You are now free to remove the bucket resource from producerStack.
        • +
      • Don't forget to remove the exportValue() call as well.
        • +
      • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
        • +
      +

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string

    exportStringListValue

    • exportStringListValue(
          exportedValue: any,
          options?: ExportValueOptions,
      ): string[]

      Create a CloudFormation Export for a string list value

      +

      Returns a string list representing the corresponding Fn.importValue() +expression for this Export. The export expression is automatically wrapped with an +Fn::Join and the import value with an Fn::Split, since CloudFormation can only +export strings. You can control the name for the export by passing the name option.

      +

      If you don't supply a value for name, the value you're exporting must be +a Resource attribute (for example: bucket.bucketName) and it will be +given the same name as the automatic cross-stack reference that would be created +if you used the attribute in another Stack.

      +

      One of the uses for this method is to remove the relationship between +two Stacks established by automatic cross-stack references. It will +temporarily ensure that the CloudFormation Export still exists while you +remove the reference from the consuming stack. After that, you can remove +the resource and the manual export.

      +

      See exportValue for an example of this process.

      +

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string[]

    ProtectedallocateLogicalId

    • allocateLogicalId(cfnElement: CfnElement): string

      Returns the naming scheme used to allocate logical IDs. By default, uses +the HashedAddressingScheme but this method can be overridden to customize +this behavior.

      +

      In order to make sure logical IDs are unique and stable, we hash the resource +construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as +a suffix to the path components joined without a separator (CloudFormation +IDs only allow alphanumeric characters).

      +

      The result will be:

      +

      <path.join('')><md5(path.join('/')> +"human" "hash"

      +

      If the "human" part of the ID exceeds 240 characters, we simply trim it so +the total ID doesn't exceed CloudFormation's 255 character limit.

      +

      We only take 8 characters from the md5 hash (0.000005 chance of collision).

      +

      Special cases:

      +
        +
      • If the path only contains a single component (i.e. it's a top-level +resource), we won't add the hash to it. The hash is not needed for +disambiguation and also, it allows for a more straightforward migration an +existing CloudFormation template to a CDK stack without logical ID changes +(or renames).
        • +
      • For aesthetic reasons, if the last components of the path are the same +(i.e. L1/L2/Pipeline/Pipeline), they will be de-duplicated to make the +resulting human portion of the ID more pleasing: L1L2Pipeline<HASH> +instead of L1L2PipelinePipeline<HASH>
        • +
      • If a component is named "Default" it will be omitted from the path. This +allows refactoring higher level abstractions around constructs without affecting +the IDs of already deployed resources.
        • +
      • If a component is named "Resource" it will be omitted from the user-visible +path, but included in the hash. This reduces visual noise in the human readable +part of the identifier.
        • +
      +

      Parameters

      • cfnElement: CfnElement

        The element for which the logical ID is allocated.

        +

      Returns string

    Protected_validateId

    • _validateId(name: string): void
      Internal

      Validate stack name

      +

      CloudFormation stack names can include dashes in addition to the regular identifier +character classes, and we don't allow one of the magic markers.

      +

      Parameters

      • name: string

      Returns void

    Protected_toCloudFormation

    • _toCloudFormation(): any
      Internal

      Returns the CloudFormation template for this stack by traversing +the tree and invoking _toCloudFormation() on all Entity objects.

      +

      Returns any

    StaticisConstruct

    • isConstruct(x: any): x is Construct

      Checks if x is a construct.

      +

      Use this method instead of instanceof to properly detect Construct +instances, even when the construct library is symlinked.

      +

      Explanation: in JavaScript, multiple copies of the constructs library on +disk are seen as independent, completely different libraries. As a +consequence, the class Construct in each copy of the constructs library +is seen as a different class, and an instance of one class will not test as +instanceof the other class. npm install will not create installations +like this, but users may manually symlink construct libraries together or +use a monorepo tool: in those cases, multiple copies of the constructs +library can be accidentally installed, and instanceof will behave +unpredictably. It is safest to avoid using instanceof, and using +this type-testing method instead.

      +

      Parameters

      • x: any

        Any object

        +

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

      +

    toString

    • toString(): string

      Returns a string representation of this construct.

      +

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/EmbeddedLinuxCodePipelineStack.html b/classes/EmbeddedLinuxCodePipelineStack.html new file mode 100644 index 0000000..941345b --- /dev/null +++ b/classes/EmbeddedLinuxCodePipelineStack.html @@ -0,0 +1,324 @@ +EmbeddedLinuxCodePipelineStack | aws4embeddedlinux-cdk-lib

    Class EmbeddedLinuxCodePipelineStack

    The stack for creating a build pipeline.

    +

    See EmbeddedLinuxCodePipelineProps for configration options.

    +

    Hierarchy

    • Stack
      • EmbeddedLinuxCodePipelineStack

    Constructors

    constructor +

    Properties

    tags +templateOptions +region +account +environment +nestedStackResource? +templateFile +artifactId +synthesizer +_versionReportingEnabled +_crossRegionReferences +_notificationArns? +node +

    Accessors

    terminationProtection +dependencies +stackName +partition +urlSuffix +stackId +notificationArns +nested +availabilityZones +nestedStackParent +bundlingRequired +

    Methods

    isStack +of +resolve +toJsonString +toYamlString +reportMissingContextKey +renameLogicalId +getLogicalId +addDependency +formatArn +splitArn +addTransform +addMetadata +_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate +regionalFact +exportValue +exportStringListValue +allocateLogicalId +_validateId +_toCloudFormation +isConstruct +toString +

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    +

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    +

    This value is resolved according to the following rules:

    +
      +
    1. The value provided to env.region when the stack is defined. This can +either be a concrete region (e.g. us-west-2) or the Aws.REGION +token.
      2. +
    2. Aws.REGION, which is represents the CloudFormation intrinsic reference +{ "Ref": "AWS::Region" } encoded as a string token.
      3. +
    +

    Preferably, you should use the return value as an opaque string and not +attempt to parse it to implement your logic. If you do, you must first +check that it is a concrete value an not an unresolved token. If this +value is an unresolved token (Token.isUnresolved(stack.region) returns +true), this implies that the user wishes that this stack will synthesize +into a region-agnostic template. In this case, your code should either +fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or +implement some other region-agnostic behavior.

    +

    Readonlyaccount

    account: string

    The AWS account into which this stack will be deployed.

    +

    This value is resolved according to the following rules:

    +
      +
    1. The value provided to env.account when the stack is defined. This can +either be a concrete account (e.g. 585695031111) or the +Aws.ACCOUNT_ID token.
      2. +
    2. Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference +{ "Ref": "AWS::AccountId" } encoded as a string token.
      3. +
    +

    Preferably, you should use the return value as an opaque string and not +attempt to parse it to implement your logic. If you do, you must first +check that it is a concrete value an not an unresolved token. If this +value is an unresolved token (Token.isUnresolved(stack.account) returns +true), this implies that the user wishes that this stack will synthesize +into a account-agnostic template. In this case, your code should either +fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or +implement some other region-agnostic behavior.

    +

    Readonlyenvironment

    environment: string

    The environment coordinates in which this stack is deployed. In the form +aws://account/region. Use stack.account and stack.region to obtain +the specific values, no need to parse.

    +

    You can use this value to determine if two stacks are targeting the same +environment.

    +

    If either stack.account or stack.region are not concrete values (e.g. +Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or +unknown-region will be used respectively to indicate this stack is +region/account-agnostic.

    +

    Optional ReadonlynestedStackResource

    nestedStackResource?: CfnResource

    If this is a nested stack, this represents its AWS::CloudFormation::Stack +resource. undefined for top-level (non-nested) stacks.

    +

    ReadonlytemplateFile

    templateFile: string

    The name of the CloudFormation template file emitted to the output +directory during synthesis.

    +

    Example value: MyStack.template.json

    +

    ReadonlyartifactId

    artifactId: string

    The ID of the cloud assembly artifact for this stack.

    +

    Readonlysynthesizer

    synthesizer: IStackSynthesizer

    Synthesis method for this stack

    +

    Readonly Internal_versionReportingEnabled

    _versionReportingEnabled: boolean

    Whether version reporting is enabled for this stack

    +

    Controls whether the CDK Metadata resource is injected

    +

    Readonly Internal_crossRegionReferences

    _crossRegionReferences: boolean

    Whether cross region references are enabled for this stack

    +

    Optional Readonly Internal_notificationArns

    _notificationArns?: string[]

    SNS Notification ARNs to receive stack events.

    +

    Readonlynode

    node: Node

    The tree node.

    +

    Accessors

    terminationProtection

    • get terminationProtection(): boolean

      Whether termination protection is enabled for this stack.

      +

      Returns boolean

    • set terminationProtection(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    dependencies

    • get dependencies(): Stack[]

      Return the stacks this stack depends on

      +

      Returns Stack[]

    stackName

    • get stackName(): string

      The concrete CloudFormation physical stack name.

      +

      This is either the name defined explicitly in the stackName prop or +allocated based on the stack's location in the construct tree. Stacks that +are directly defined under the app use their construct id as their stack +name. Stacks that are defined deeper within the tree will use a hashed naming +scheme based on the construct path to ensure uniqueness.

      +

      If you wish to obtain the deploy-time AWS::StackName intrinsic, +you can use Aws.STACK_NAME directly.

      +

      Returns string

    partition

    • get partition(): string

      The partition in which this stack is defined

      +

      Returns string

    urlSuffix

    • get urlSuffix(): string

      The Amazon domain suffix for the region in which this stack is defined

      +

      Returns string

    stackId

    • get stackId(): string

      The ID of the stack

      +

      Returns string

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+
      + +

    notificationArns

    • get notificationArns(): string[]

      Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      +

      Returns string[]

    nested

    • get nested(): boolean

      Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      +

      Returns boolean

    availabilityZones

    • get availabilityZones(): string[]

      Returns the list of AZs that are available in the AWS environment +(account/region) associated with this stack.

      +

      If the stack is environment-agnostic (either account and/or region are +tokens), this property will return an array with 2 tokens that will resolve +at deploy-time to the first two availability zones returned from CloudFormation's +Fn::GetAZs intrinsic function.

      +

      If they are not available in the context, returns a set of dummy values and +reports them as missing, and let the CLI resolve them by calling EC2 +DescribeAvailabilityZones on the target environment.

      +

      To specify a different strategy for selecting availability zones override this method.

      +

      Returns string[]

    nestedStackParent

    • get nestedStackParent(): undefined | Stack

      If this is a nested stack, returns it's parent stack.

      +

      Returns undefined | Stack

    bundlingRequired

    • get bundlingRequired(): boolean

      Indicates whether the stack requires bundling or not

      +

      Returns boolean

    Methods

    StaticisStack

    • isStack(x: any): x is Stack

      Return whether the given object is a Stack.

      +

      We do attribute detection since we can't reliably use 'instanceof'.

      +

      Parameters

      • x: any

      Returns x is Stack

    Staticof

    • of(construct: IConstruct): Stack

      Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      +

      Parameters

      • construct: IConstruct

        The construct to start the search from.

        +

      Returns Stack

    resolve

    • resolve(obj: any): any

      Resolve a tokenized value in the context of the current stack.

      +

      Parameters

      • obj: any

      Returns any

    toJsonString

    • toJsonString(obj: any, space?: number): string

      Convert an object, potentially containing tokens, to a JSON string

      +

      Parameters

      • obj: any
      • Optionalspace: number

      Returns string

    toYamlString

    • toYamlString(obj: any): string

      Convert an object, potentially containing tokens, to a YAML string

      +

      Parameters

      • obj: any

      Returns string

    reportMissingContextKey

    • reportMissingContextKey(report: MissingContext): void

      Indicate that a context key was expected

      +

      Contains instructions which will be emitted into the cloud assembly on how +the key should be supplied.

      +

      Parameters

      • report: MissingContext

        The set of parameters needed to obtain the context

        +

      Returns void

    renameLogicalId

    • renameLogicalId(oldId: string, newId: string): void

      Rename a generated logical identities

      +

      To modify the naming scheme strategy, extend the Stack class and +override the allocateLogicalId method.

      +

      Parameters

      • oldId: string
      • newId: string

      Returns void

    getLogicalId

    • getLogicalId(element: CfnElement): string

      Allocates a stack-unique CloudFormation-compatible logical identity for a +specific resource.

      +

      This method is called when a CfnElement is created and used to render the +initial logical identity of resources. Logical ID renames are applied at +this stage.

      +

      This method uses the protected method allocateLogicalId to render the +logical ID for an element. To modify the naming scheme, extend the Stack +class and override this method.

      +

      Parameters

      • element: CfnElement

        The CloudFormation element for which a logical identity is +needed.

        +

      Returns string

    addDependency

    • addDependency(target: Stack, reason?: string): void

      Add a dependency between this stack and another stack.

      +

      This can be used to define dependencies between any two stacks within an +app, and also supports nested stacks.

      +

      Parameters

      • target: Stack
      • Optionalreason: string

      Returns void

    formatArn

    • formatArn(components: ArnComponents): string

      Creates an ARN from components.

      +

      If partition, region or account are not specified, the stack's +partition, region and account will be used.

      +

      If any component is the empty string, an empty string will be inserted +into the generated ARN at the location that component corresponds to.

      +

      The ARN will be formatted as follows:

      +

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      +

      The required ARN pieces that are omitted will be taken from the stack that +the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope +can be 'undefined'.

      +

      Parameters

      • components: ArnComponents

      Returns string

    splitArn

    • splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

      Splits the provided ARN into its components. +Works both if 'arn' is a string like 'arn:aws:s3:::bucket', +and a Token representing a dynamic CloudFormation expression +(in which case the returned components will also be dynamic CloudFormation expressions, +encoded as Tokens).

      +

      Parameters

      • arn: string

        the ARN to split into its components

        +
      • arnFormat: ArnFormat

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        +

      Returns ArnComponents

    addTransform

    • addTransform(transform: string): void

      Add a Transform to this stack. A Transform is a macro that AWS +CloudFormation uses to process your template.

      +

      Duplicate values are removed when stack is synthesized.

      +

      Parameters

      • transform: string

        The transform to add

        +

      Returns void

      See

      https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

      +

      Example

      declare const stack: Stack;

      stack.addTransform('AWS::Serverless-2016-10-31')
+
      + +

    addMetadata

    _addAssemblyDependency

    • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
      Internal

      Called implicitly by the addDependency helper function in order to +realize a dependency between two top-level stacks at the assembly level.

      +

      Use stack.addDependency to define the dependency between any two stacks, +and take into account nested stack relationships.

      +

      Parameters

      • target: Stack
      • Optionalreason: StackDependencyReason

      Returns void

    _obtainAssemblyDependencies

    • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
      Internal

      Called implicitly by the obtainDependencies helper function in order to +collect resource dependencies across two top-level stacks at the assembly level.

      +

      Use stack.obtainDependencies to see the dependencies between any two stacks.

      +

      Parameters

      • reasonFilter: StackDependencyReason

      Returns Element[]

    _removeAssemblyDependency

    • _removeAssemblyDependency(
          target: Stack,
          reasonFilter?: StackDependencyReason,
      ): void
      Internal

      Called implicitly by the removeDependency helper function in order to +remove a dependency between two top-level stacks at the assembly level.

      +

      Use stack.addDependency to define the dependency between any two stacks, +and take into account nested stack relationships.

      +

      Parameters

      • target: Stack
      • OptionalreasonFilter: StackDependencyReason

      Returns void

    _synthesizeTemplate

    • _synthesizeTemplate(
          session: ISynthesisSession,
          lookupRoleArn?: string,
          lookupRoleExternalId?: string,
          lookupRoleAdditionalOptions?: { [key: string]: any },
      ): void
      Internal

      Synthesizes the cloudformation template into a cloud assembly.

      +

      Parameters

      • session: ISynthesisSession
      • OptionallookupRoleArn: string
      • OptionallookupRoleExternalId: string
      • OptionallookupRoleAdditionalOptions: { [key: string]: any }

      Returns void

    regionalFact

    • regionalFact(factName: string, defaultValue?: string): string

      Look up a fact value for the given fact for the region of this stack

      +

      Will return a definite value only if the region of the current stack is resolved. +If not, a lookup map will be added to the stack and the lookup will be done at +CDK deployment time.

      +

      What regions will be included in the lookup map is controlled by the +@aws-cdk/core:target-partitions context value: it must be set to a list +of partitions, and only regions from the given partitions will be included. +If no such context key is set, all regions will be included.

      +

      This function is intended to be used by construct library authors. Application +builders can rely on the abstractions offered by construct libraries and do +not have to worry about regional facts.

      +

      If defaultValue is not given, it is an error if the fact is unknown for +the given region.

      +

      Parameters

      • factName: string
      • OptionaldefaultValue: string

      Returns string

    exportValue

    • exportValue(exportedValue: any, options?: ExportValueOptions): string

      Create a CloudFormation Export for a string value

      +

      Returns a string representing the corresponding Fn.importValue() +expression for this Export. You can control the name for the export by +passing the name option.

      +

      If you don't supply a value for name, the value you're exporting must be +a Resource attribute (for example: bucket.bucketName) and it will be +given the same name as the automatic cross-stack reference that would be created +if you used the attribute in another Stack.

      +

      One of the uses for this method is to remove the relationship between +two Stacks established by automatic cross-stack references. It will +temporarily ensure that the CloudFormation Export still exists while you +remove the reference from the consuming stack. After that, you can remove +the resource and the manual export.

      +

      Here is how the process works. Let's say there are two stacks, +producerStack and consumerStack, and producerStack has a bucket +called bucket, which is referenced by consumerStack (perhaps because +an AWS Lambda Function writes into it, or something like that).

      +

      It is not safe to remove producerStack.bucket because as the bucket is being +deleted, consumerStack might still be using it.

      +

      Instead, the process takes two deployments:

      +

      Deployment 1: break the relationship:

      +
        +
      • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer +stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just +remove the Lambda Function altogether).
        • +
      • In the ProducerStack class, call this.exportValue(this.bucket.bucketName). This +will make sure the CloudFormation Export continues to exist while the relationship +between the two stacks is being broken.
        • +
      • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).
        • +
      +

      Deployment 2: remove the bucket resource:

      +
        +
      • You are now free to remove the bucket resource from producerStack.
        • +
      • Don't forget to remove the exportValue() call as well.
        • +
      • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
        • +
      +

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string

    exportStringListValue

    • exportStringListValue(
          exportedValue: any,
          options?: ExportValueOptions,
      ): string[]

      Create a CloudFormation Export for a string list value

      +

      Returns a string list representing the corresponding Fn.importValue() +expression for this Export. The export expression is automatically wrapped with an +Fn::Join and the import value with an Fn::Split, since CloudFormation can only +export strings. You can control the name for the export by passing the name option.

      +

      If you don't supply a value for name, the value you're exporting must be +a Resource attribute (for example: bucket.bucketName) and it will be +given the same name as the automatic cross-stack reference that would be created +if you used the attribute in another Stack.

      +

      One of the uses for this method is to remove the relationship between +two Stacks established by automatic cross-stack references. It will +temporarily ensure that the CloudFormation Export still exists while you +remove the reference from the consuming stack. After that, you can remove +the resource and the manual export.

      +

      See exportValue for an example of this process.

      +

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string[]

    ProtectedallocateLogicalId

    • allocateLogicalId(cfnElement: CfnElement): string

      Returns the naming scheme used to allocate logical IDs. By default, uses +the HashedAddressingScheme but this method can be overridden to customize +this behavior.

      +

      In order to make sure logical IDs are unique and stable, we hash the resource +construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as +a suffix to the path components joined without a separator (CloudFormation +IDs only allow alphanumeric characters).

      +

      The result will be:

      +

      <path.join('')><md5(path.join('/')> +"human" "hash"

      +

      If the "human" part of the ID exceeds 240 characters, we simply trim it so +the total ID doesn't exceed CloudFormation's 255 character limit.

      +

      We only take 8 characters from the md5 hash (0.000005 chance of collision).

      +

      Special cases:

      +
        +
      • If the path only contains a single component (i.e. it's a top-level +resource), we won't add the hash to it. The hash is not needed for +disambiguation and also, it allows for a more straightforward migration an +existing CloudFormation template to a CDK stack without logical ID changes +(or renames).
        • +
      • For aesthetic reasons, if the last components of the path are the same +(i.e. L1/L2/Pipeline/Pipeline), they will be de-duplicated to make the +resulting human portion of the ID more pleasing: L1L2Pipeline<HASH> +instead of L1L2PipelinePipeline<HASH>
        • +
      • If a component is named "Default" it will be omitted from the path. This +allows refactoring higher level abstractions around constructs without affecting +the IDs of already deployed resources.
        • +
      • If a component is named "Resource" it will be omitted from the user-visible +path, but included in the hash. This reduces visual noise in the human readable +part of the identifier.
        • +
      +

      Parameters

      • cfnElement: CfnElement

        The element for which the logical ID is allocated.

        +

      Returns string

    Protected_validateId

    • _validateId(name: string): void
      Internal

      Validate stack name

      +

      CloudFormation stack names can include dashes in addition to the regular identifier +character classes, and we don't allow one of the magic markers.

      +

      Parameters

      • name: string

      Returns void

    Protected_toCloudFormation

    • _toCloudFormation(): any
      Internal

      Returns the CloudFormation template for this stack by traversing +the tree and invoking _toCloudFormation() on all Entity objects.

      +

      Returns any

    StaticisConstruct

    • isConstruct(x: any): x is Construct

      Checks if x is a construct.

      +

      Use this method instead of instanceof to properly detect Construct +instances, even when the construct library is symlinked.

      +

      Explanation: in JavaScript, multiple copies of the constructs library on +disk are seen as independent, completely different libraries. As a +consequence, the class Construct in each copy of the constructs library +is seen as a different class, and an instance of one class will not test as +instanceof the other class. npm install will not create installations +like this, but users may manually symlink construct libraries together or +use a monorepo tool: in those cases, multiple copies of the constructs +library can be accidentally installed, and instanceof will behave +unpredictably. It is safest to avoid using instanceof, and using +this type-testing method instead.

      +

      Parameters

      • x: any

        Any object

        +

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

      +

    toString

    • toString(): string

      Returns a string representation of this construct.

      +

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/EmbeddedLinuxCodebuildProjectStack.html b/classes/EmbeddedLinuxCodebuildProjectStack.html deleted file mode 100644 index 7706094..0000000 --- a/classes/EmbeddedLinuxCodebuildProjectStack.html +++ /dev/null @@ -1,324 +0,0 @@ -EmbeddedLinuxCodebuildProjectStack | aws4embeddedlinux-cdk-lib

    Class EmbeddedLinuxCodebuildProjectStack

    The stack for creating a build pipeline.

    -

    See EmbeddedLinuxCodebuildProjectProps for configration options.

    -

    Hierarchy

    • Stack
      • EmbeddedLinuxCodebuildProjectStack

    Constructors

    constructor -

    Properties

    tags -templateOptions -region -account -environment -nestedStackResource? -templateFile -artifactId -synthesizer -_versionReportingEnabled -_crossRegionReferences -_notificationArns? -node -

    Accessors

    terminationProtection -dependencies -stackName -partition -urlSuffix -stackId -notificationArns -nested -availabilityZones -nestedStackParent -bundlingRequired -

    Methods

    isStack -of -resolve -toJsonString -toYamlString -reportMissingContextKey -renameLogicalId -getLogicalId -addDependency -formatArn -splitArn -addTransform -addMetadata -_addAssemblyDependency -_obtainAssemblyDependencies -_removeAssemblyDependency -_synthesizeTemplate -regionalFact -exportValue -exportStringListValue -allocateLogicalId -_validateId -_toCloudFormation -isConstruct -toString -

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    -

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    -

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    -

    This value is resolved according to the following rules:

    -
      -
    1. The value provided to env.region when the stack is defined. This can -either be a concrete region (e.g. us-west-2) or the Aws.REGION -token.
      2. -
    2. Aws.REGION, which is represents the CloudFormation intrinsic reference -{ "Ref": "AWS::Region" } encoded as a string token.
      3. -
    -

    Preferably, you should use the return value as an opaque string and not -attempt to parse it to implement your logic. If you do, you must first -check that it is a concrete value an not an unresolved token. If this -value is an unresolved token (Token.isUnresolved(stack.region) returns -true), this implies that the user wishes that this stack will synthesize -into a region-agnostic template. In this case, your code should either -fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or -implement some other region-agnostic behavior.

    -

    Readonlyaccount

    account: string

    The AWS account into which this stack will be deployed.

    -

    This value is resolved according to the following rules:

    -
      -
    1. The value provided to env.account when the stack is defined. This can -either be a concrete account (e.g. 585695031111) or the -Aws.ACCOUNT_ID token.
      2. -
    2. Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference -{ "Ref": "AWS::AccountId" } encoded as a string token.
      3. -
    -

    Preferably, you should use the return value as an opaque string and not -attempt to parse it to implement your logic. If you do, you must first -check that it is a concrete value an not an unresolved token. If this -value is an unresolved token (Token.isUnresolved(stack.account) returns -true), this implies that the user wishes that this stack will synthesize -into a account-agnostic template. In this case, your code should either -fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or -implement some other region-agnostic behavior.

    -

    Readonlyenvironment

    environment: string

    The environment coordinates in which this stack is deployed. In the form -aws://account/region. Use stack.account and stack.region to obtain -the specific values, no need to parse.

    -

    You can use this value to determine if two stacks are targeting the same -environment.

    -

    If either stack.account or stack.region are not concrete values (e.g. -Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or -unknown-region will be used respectively to indicate this stack is -region/account-agnostic.

    -

    Optional ReadonlynestedStackResource

    nestedStackResource?: CfnResource

    If this is a nested stack, this represents its AWS::CloudFormation::Stack -resource. undefined for top-level (non-nested) stacks.

    -

    ReadonlytemplateFile

    templateFile: string

    The name of the CloudFormation template file emitted to the output -directory during synthesis.

    -

    Example value: MyStack.template.json

    -

    ReadonlyartifactId

    artifactId: string

    The ID of the cloud assembly artifact for this stack.

    -

    Readonlysynthesizer

    synthesizer: IStackSynthesizer

    Synthesis method for this stack

    -

    Readonly Internal_versionReportingEnabled

    _versionReportingEnabled: boolean

    Whether version reporting is enabled for this stack

    -

    Controls whether the CDK Metadata resource is injected

    -

    Readonly Internal_crossRegionReferences

    _crossRegionReferences: boolean

    Whether cross region references are enabled for this stack

    -

    Optional Readonly Internal_notificationArns

    _notificationArns?: string[]

    SNS Notification ARNs to receive stack events.

    -

    Readonlynode

    node: Node

    The tree node.

    -

    Accessors

    terminationProtection

    • get terminationProtection(): boolean

    • Whether termination protection is enabled for this stack.

      -

      Returns boolean

    • set terminationProtection(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    dependencies

    • get dependencies(): Stack[]

    • Return the stacks this stack depends on

      -

      Returns Stack[]

    stackName

    • get stackName(): string

    • The concrete CloudFormation physical stack name.

      -

      This is either the name defined explicitly in the stackName prop or -allocated based on the stack's location in the construct tree. Stacks that -are directly defined under the app use their construct id as their stack -name. Stacks that are defined deeper within the tree will use a hashed naming -scheme based on the construct path to ensure uniqueness.

      -

      If you wish to obtain the deploy-time AWS::StackName intrinsic, -you can use Aws.STACK_NAME directly.

      -

      Returns string

    partition

    • get partition(): string

    • The partition in which this stack is defined

      -

      Returns string

    urlSuffix

    • get urlSuffix(): string

    • The Amazon domain suffix for the region in which this stack is defined

      -

      Returns string

    stackId

    • get stackId(): string

    • The ID of the stack

      -

      Returns string

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
-
      - -

    notificationArns

    • get notificationArns(): string[]

    • Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      -

      Returns string[]

    nested

    • get nested(): boolean

    • Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      -

      Returns boolean

    availabilityZones

    • get availabilityZones(): string[]

    • Returns the list of AZs that are available in the AWS environment -(account/region) associated with this stack.

      -

      If the stack is environment-agnostic (either account and/or region are -tokens), this property will return an array with 2 tokens that will resolve -at deploy-time to the first two availability zones returned from CloudFormation's -Fn::GetAZs intrinsic function.

      -

      If they are not available in the context, returns a set of dummy values and -reports them as missing, and let the CLI resolve them by calling EC2 -DescribeAvailabilityZones on the target environment.

      -

      To specify a different strategy for selecting availability zones override this method.

      -

      Returns string[]

    nestedStackParent

    • get nestedStackParent(): undefined | Stack

    • If this is a nested stack, returns it's parent stack.

      -

      Returns undefined | Stack

    bundlingRequired

    • get bundlingRequired(): boolean

    • Indicates whether the stack requires bundling or not

      -

      Returns boolean

    Methods

    StaticisStack

    • isStack(x: any): x is Stack

    • Return whether the given object is a Stack.

      -

      We do attribute detection since we can't reliably use 'instanceof'.

      -

      Parameters

      • x: any

      Returns x is Stack

    Staticof

    • of(construct: IConstruct): Stack

    • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      -

      Parameters

      • construct: IConstruct

        The construct to start the search from.

        -

      Returns Stack

    resolve

    • resolve(obj: any): any

    • Resolve a tokenized value in the context of the current stack.

      -

      Parameters

      • obj: any

      Returns any

    toJsonString

    • toJsonString(obj: any, space?: number): string

    • Convert an object, potentially containing tokens, to a JSON string

      -

      Parameters

      • obj: any
      • Optionalspace: number

      Returns string

    toYamlString

    • toYamlString(obj: any): string

    • Convert an object, potentially containing tokens, to a YAML string

      -

      Parameters

      • obj: any

      Returns string

    reportMissingContextKey

    • reportMissingContextKey(report: MissingContext): void

    • Indicate that a context key was expected

      -

      Contains instructions which will be emitted into the cloud assembly on how -the key should be supplied.

      -

      Parameters

      • report: MissingContext

        The set of parameters needed to obtain the context

        -

      Returns void

    renameLogicalId

    • renameLogicalId(oldId: string, newId: string): void

    • Rename a generated logical identities

      -

      To modify the naming scheme strategy, extend the Stack class and -override the allocateLogicalId method.

      -

      Parameters

      • oldId: string
      • newId: string

      Returns void

    getLogicalId

    • getLogicalId(element: CfnElement): string

    • Allocates a stack-unique CloudFormation-compatible logical identity for a -specific resource.

      -

      This method is called when a CfnElement is created and used to render the -initial logical identity of resources. Logical ID renames are applied at -this stage.

      -

      This method uses the protected method allocateLogicalId to render the -logical ID for an element. To modify the naming scheme, extend the Stack -class and override this method.

      -

      Parameters

      • element: CfnElement

        The CloudFormation element for which a logical identity is -needed.

        -

      Returns string

    addDependency

    • addDependency(target: Stack, reason?: string): void

    • Add a dependency between this stack and another stack.

      -

      This can be used to define dependencies between any two stacks within an -app, and also supports nested stacks.

      -

      Parameters

      • target: Stack
      • Optionalreason: string

      Returns void

    formatArn

    • formatArn(components: ArnComponents): string

    • Creates an ARN from components.

      -

      If partition, region or account are not specified, the stack's -partition, region and account will be used.

      -

      If any component is the empty string, an empty string will be inserted -into the generated ARN at the location that component corresponds to.

      -

      The ARN will be formatted as follows:

      -

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      -

      The required ARN pieces that are omitted will be taken from the stack that -the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope -can be 'undefined'.

      -

      Parameters

      • components: ArnComponents

      Returns string

    splitArn

    • splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

    • Splits the provided ARN into its components. -Works both if 'arn' is a string like 'arn:aws:s3:::bucket', -and a Token representing a dynamic CloudFormation expression -(in which case the returned components will also be dynamic CloudFormation expressions, -encoded as Tokens).

      -

      Parameters

      • arn: string

        the ARN to split into its components

        -
      • arnFormat: ArnFormat

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        -

      Returns ArnComponents

    addTransform

    • addTransform(transform: string): void

    • Add a Transform to this stack. A Transform is a macro that AWS -CloudFormation uses to process your template.

      -

      Duplicate values are removed when stack is synthesized.

      -

      Parameters

      • transform: string

        The transform to add

        -

      Returns void

      See

      https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

      -

      Example

      declare const stack: Stack;

      stack.addTransform('AWS::Serverless-2016-10-31')
-
      - -

    addMetadata

    _addAssemblyDependency

    • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
    • Internal

      Called implicitly by the addDependency helper function in order to -realize a dependency between two top-level stacks at the assembly level.

      -

      Use stack.addDependency to define the dependency between any two stacks, -and take into account nested stack relationships.

      -

      Parameters

      • target: Stack
      • Optionalreason: StackDependencyReason

      Returns void

    _obtainAssemblyDependencies

    • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
    • Internal

      Called implicitly by the obtainDependencies helper function in order to -collect resource dependencies across two top-level stacks at the assembly level.

      -

      Use stack.obtainDependencies to see the dependencies between any two stacks.

      -

      Parameters

      • reasonFilter: StackDependencyReason

      Returns Element[]

    _removeAssemblyDependency

    • _removeAssemblyDependency(
          target: Stack,
          reasonFilter?: StackDependencyReason,
      ): void
    • Internal

      Called implicitly by the removeDependency helper function in order to -remove a dependency between two top-level stacks at the assembly level.

      -

      Use stack.addDependency to define the dependency between any two stacks, -and take into account nested stack relationships.

      -

      Parameters

      • target: Stack
      • OptionalreasonFilter: StackDependencyReason

      Returns void

    _synthesizeTemplate

    • _synthesizeTemplate(
          session: ISynthesisSession,
          lookupRoleArn?: string,
          lookupRoleExternalId?: string,
          lookupRoleAdditionalOptions?: { [key: string]: any },
      ): void
    • Internal

      Synthesizes the cloudformation template into a cloud assembly.

      -

      Parameters

      • session: ISynthesisSession
      • OptionallookupRoleArn: string
      • OptionallookupRoleExternalId: string
      • OptionallookupRoleAdditionalOptions: { [key: string]: any }

      Returns void

    regionalFact

    • regionalFact(factName: string, defaultValue?: string): string

    • Look up a fact value for the given fact for the region of this stack

      -

      Will return a definite value only if the region of the current stack is resolved. -If not, a lookup map will be added to the stack and the lookup will be done at -CDK deployment time.

      -

      What regions will be included in the lookup map is controlled by the -@aws-cdk/core:target-partitions context value: it must be set to a list -of partitions, and only regions from the given partitions will be included. -If no such context key is set, all regions will be included.

      -

      This function is intended to be used by construct library authors. Application -builders can rely on the abstractions offered by construct libraries and do -not have to worry about regional facts.

      -

      If defaultValue is not given, it is an error if the fact is unknown for -the given region.

      -

      Parameters

      • factName: string
      • OptionaldefaultValue: string

      Returns string

    exportValue

    • exportValue(exportedValue: any, options?: ExportValueOptions): string

    • Create a CloudFormation Export for a string value

      -

      Returns a string representing the corresponding Fn.importValue() -expression for this Export. You can control the name for the export by -passing the name option.

      -

      If you don't supply a value for name, the value you're exporting must be -a Resource attribute (for example: bucket.bucketName) and it will be -given the same name as the automatic cross-stack reference that would be created -if you used the attribute in another Stack.

      -

      One of the uses for this method is to remove the relationship between -two Stacks established by automatic cross-stack references. It will -temporarily ensure that the CloudFormation Export still exists while you -remove the reference from the consuming stack. After that, you can remove -the resource and the manual export.

      -

      Here is how the process works. Let's say there are two stacks, -producerStack and consumerStack, and producerStack has a bucket -called bucket, which is referenced by consumerStack (perhaps because -an AWS Lambda Function writes into it, or something like that).

      -

      It is not safe to remove producerStack.bucket because as the bucket is being -deleted, consumerStack might still be using it.

      -

      Instead, the process takes two deployments:

      -

      Deployment 1: break the relationship:

      -
        -
      • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer -stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just -remove the Lambda Function altogether).
        • -
      • In the ProducerStack class, call this.exportValue(this.bucket.bucketName). This -will make sure the CloudFormation Export continues to exist while the relationship -between the two stacks is being broken.
        • -
      • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).
        • -
      -

      Deployment 2: remove the bucket resource:

      -
        -
      • You are now free to remove the bucket resource from producerStack.
        • -
      • Don't forget to remove the exportValue() call as well.
        • -
      • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
        • -
      -

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string

    exportStringListValue

    • exportStringListValue(
          exportedValue: any,
          options?: ExportValueOptions,
      ): string[]

    • Create a CloudFormation Export for a string list value

      -

      Returns a string list representing the corresponding Fn.importValue() -expression for this Export. The export expression is automatically wrapped with an -Fn::Join and the import value with an Fn::Split, since CloudFormation can only -export strings. You can control the name for the export by passing the name option.

      -

      If you don't supply a value for name, the value you're exporting must be -a Resource attribute (for example: bucket.bucketName) and it will be -given the same name as the automatic cross-stack reference that would be created -if you used the attribute in another Stack.

      -

      One of the uses for this method is to remove the relationship between -two Stacks established by automatic cross-stack references. It will -temporarily ensure that the CloudFormation Export still exists while you -remove the reference from the consuming stack. After that, you can remove -the resource and the manual export.

      -

      See exportValue for an example of this process.

      -

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string[]

    ProtectedallocateLogicalId

    • allocateLogicalId(cfnElement: CfnElement): string

    • Returns the naming scheme used to allocate logical IDs. By default, uses -the HashedAddressingScheme but this method can be overridden to customize -this behavior.

      -

      In order to make sure logical IDs are unique and stable, we hash the resource -construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as -a suffix to the path components joined without a separator (CloudFormation -IDs only allow alphanumeric characters).

      -

      The result will be:

      -

      <path.join('')><md5(path.join('/')> -"human" "hash"

      -

      If the "human" part of the ID exceeds 240 characters, we simply trim it so -the total ID doesn't exceed CloudFormation's 255 character limit.

      -

      We only take 8 characters from the md5 hash (0.000005 chance of collision).

      -

      Special cases:

      -
        -
      • If the path only contains a single component (i.e. it's a top-level -resource), we won't add the hash to it. The hash is not needed for -disambiguation and also, it allows for a more straightforward migration an -existing CloudFormation template to a CDK stack without logical ID changes -(or renames).
        • -
      • For aesthetic reasons, if the last components of the path are the same -(i.e. L1/L2/Pipeline/Pipeline), they will be de-duplicated to make the -resulting human portion of the ID more pleasing: L1L2Pipeline<HASH> -instead of L1L2PipelinePipeline<HASH>
        • -
      • If a component is named "Default" it will be omitted from the path. This -allows refactoring higher level abstractions around constructs without affecting -the IDs of already deployed resources.
        • -
      • If a component is named "Resource" it will be omitted from the user-visible -path, but included in the hash. This reduces visual noise in the human readable -part of the identifier.
        • -
      -

      Parameters

      • cfnElement: CfnElement

        The element for which the logical ID is allocated.

        -

      Returns string

    Protected_validateId

    • _validateId(name: string): void
    • Internal

      Validate stack name

      -

      CloudFormation stack names can include dashes in addition to the regular identifier -character classes, and we don't allow one of the magic markers.

      -

      Parameters

      • name: string

      Returns void

    Protected_toCloudFormation

    • _toCloudFormation(): any
    • Internal

      Returns the CloudFormation template for this stack by traversing -the tree and invoking _toCloudFormation() on all Entity objects.

      -

      Returns any

    StaticisConstruct

    • isConstruct(x: any): x is Construct

    • Checks if x is a construct.

      -

      Use this method instead of instanceof to properly detect Construct -instances, even when the construct library is symlinked.

      -

      Explanation: in JavaScript, multiple copies of the constructs library on -disk are seen as independent, completely different libraries. As a -consequence, the class Construct in each copy of the constructs library -is seen as a different class, and an instance of one class will not test as -instanceof the other class. npm install will not create installations -like this, but users may manually symlink construct libraries together or -use a monorepo tool: in those cases, multiple copies of the constructs -library can be accidentally installed, and instanceof will behave -unpredictably. It is safest to avoid using instanceof, and using -this type-testing method instead.

      -

      Parameters

      • x: any

        Any object

        -

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

      -

    toString

    • toString(): string

    • Returns a string representation of this construct.

      -

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/EmbeddedLinuxPipelineStack.html b/classes/EmbeddedLinuxPipelineStack.html deleted file mode 100644 index bcf1b69..0000000 --- a/classes/EmbeddedLinuxPipelineStack.html +++ /dev/null @@ -1,324 +0,0 @@ -EmbeddedLinuxPipelineStack | aws4embeddedlinux-cdk-lib

    Class EmbeddedLinuxPipelineStack

    The stack for creating a build pipeline.

    -

    See EmbeddedLinuxPipelineProps for configration options.

    -

    Hierarchy

    • Stack
      • EmbeddedLinuxPipelineStack

    Constructors

    constructor -

    Properties

    tags -templateOptions -region -account -environment -nestedStackResource? -templateFile -artifactId -synthesizer -_versionReportingEnabled -_crossRegionReferences -_notificationArns? -node -

    Accessors

    terminationProtection -dependencies -stackName -partition -urlSuffix -stackId -notificationArns -nested -availabilityZones -nestedStackParent -bundlingRequired -

    Methods

    isStack -of -resolve -toJsonString -toYamlString -reportMissingContextKey -renameLogicalId -getLogicalId -addDependency -formatArn -splitArn -addTransform -addMetadata -_addAssemblyDependency -_obtainAssemblyDependencies -_removeAssemblyDependency -_synthesizeTemplate -regionalFact -exportValue -exportStringListValue -allocateLogicalId -_validateId -_toCloudFormation -isConstruct -toString -

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    -

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    -

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    -

    This value is resolved according to the following rules:

    -
      -
    1. The value provided to env.region when the stack is defined. This can -either be a concrete region (e.g. us-west-2) or the Aws.REGION -token.
      2. -
    2. Aws.REGION, which is represents the CloudFormation intrinsic reference -{ "Ref": "AWS::Region" } encoded as a string token.
      3. -
    -

    Preferably, you should use the return value as an opaque string and not -attempt to parse it to implement your logic. If you do, you must first -check that it is a concrete value an not an unresolved token. If this -value is an unresolved token (Token.isUnresolved(stack.region) returns -true), this implies that the user wishes that this stack will synthesize -into a region-agnostic template. In this case, your code should either -fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or -implement some other region-agnostic behavior.

    -

    Readonlyaccount

    account: string

    The AWS account into which this stack will be deployed.

    -

    This value is resolved according to the following rules:

    -
      -
    1. The value provided to env.account when the stack is defined. This can -either be a concrete account (e.g. 585695031111) or the -Aws.ACCOUNT_ID token.
      2. -
    2. Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference -{ "Ref": "AWS::AccountId" } encoded as a string token.
      3. -
    -

    Preferably, you should use the return value as an opaque string and not -attempt to parse it to implement your logic. If you do, you must first -check that it is a concrete value an not an unresolved token. If this -value is an unresolved token (Token.isUnresolved(stack.account) returns -true), this implies that the user wishes that this stack will synthesize -into a account-agnostic template. In this case, your code should either -fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or -implement some other region-agnostic behavior.

    -

    Readonlyenvironment

    environment: string

    The environment coordinates in which this stack is deployed. In the form -aws://account/region. Use stack.account and stack.region to obtain -the specific values, no need to parse.

    -

    You can use this value to determine if two stacks are targeting the same -environment.

    -

    If either stack.account or stack.region are not concrete values (e.g. -Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or -unknown-region will be used respectively to indicate this stack is -region/account-agnostic.

    -

    Optional ReadonlynestedStackResource

    nestedStackResource?: CfnResource

    If this is a nested stack, this represents its AWS::CloudFormation::Stack -resource. undefined for top-level (non-nested) stacks.

    -

    ReadonlytemplateFile

    templateFile: string

    The name of the CloudFormation template file emitted to the output -directory during synthesis.

    -

    Example value: MyStack.template.json

    -

    ReadonlyartifactId

    artifactId: string

    The ID of the cloud assembly artifact for this stack.

    -

    Readonlysynthesizer

    synthesizer: IStackSynthesizer

    Synthesis method for this stack

    -

    Readonly Internal_versionReportingEnabled

    _versionReportingEnabled: boolean

    Whether version reporting is enabled for this stack

    -

    Controls whether the CDK Metadata resource is injected

    -

    Readonly Internal_crossRegionReferences

    _crossRegionReferences: boolean

    Whether cross region references are enabled for this stack

    -

    Optional Readonly Internal_notificationArns

    _notificationArns?: string[]

    SNS Notification ARNs to receive stack events.

    -

    Readonlynode

    node: Node

    The tree node.

    -

    Accessors

    terminationProtection

    • get terminationProtection(): boolean

    • Whether termination protection is enabled for this stack.

      -

      Returns boolean

    • set terminationProtection(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    dependencies

    • get dependencies(): Stack[]

    • Return the stacks this stack depends on

      -

      Returns Stack[]

    stackName

    • get stackName(): string

    • The concrete CloudFormation physical stack name.

      -

      This is either the name defined explicitly in the stackName prop or -allocated based on the stack's location in the construct tree. Stacks that -are directly defined under the app use their construct id as their stack -name. Stacks that are defined deeper within the tree will use a hashed naming -scheme based on the construct path to ensure uniqueness.

      -

      If you wish to obtain the deploy-time AWS::StackName intrinsic, -you can use Aws.STACK_NAME directly.

      -

      Returns string

    partition

    • get partition(): string

    • The partition in which this stack is defined

      -

      Returns string

    urlSuffix

    • get urlSuffix(): string

    • The Amazon domain suffix for the region in which this stack is defined

      -

      Returns string

    stackId

    • get stackId(): string

    • The ID of the stack

      -

      Returns string

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
-
      - -

    notificationArns

    • get notificationArns(): string[]

    • Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      -

      Returns string[]

    nested

    • get nested(): boolean

    • Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      -

      Returns boolean

    availabilityZones

    • get availabilityZones(): string[]

    • Returns the list of AZs that are available in the AWS environment -(account/region) associated with this stack.

      -

      If the stack is environment-agnostic (either account and/or region are -tokens), this property will return an array with 2 tokens that will resolve -at deploy-time to the first two availability zones returned from CloudFormation's -Fn::GetAZs intrinsic function.

      -

      If they are not available in the context, returns a set of dummy values and -reports them as missing, and let the CLI resolve them by calling EC2 -DescribeAvailabilityZones on the target environment.

      -

      To specify a different strategy for selecting availability zones override this method.

      -

      Returns string[]

    nestedStackParent

    • get nestedStackParent(): undefined | Stack

    • If this is a nested stack, returns it's parent stack.

      -

      Returns undefined | Stack

    bundlingRequired

    • get bundlingRequired(): boolean

    • Indicates whether the stack requires bundling or not

      -

      Returns boolean

    Methods

    StaticisStack

    • isStack(x: any): x is Stack

    • Return whether the given object is a Stack.

      -

      We do attribute detection since we can't reliably use 'instanceof'.

      -

      Parameters

      • x: any

      Returns x is Stack

    Staticof

    • of(construct: IConstruct): Stack

    • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      -

      Parameters

      • construct: IConstruct

        The construct to start the search from.

        -

      Returns Stack

    resolve

    • resolve(obj: any): any

    • Resolve a tokenized value in the context of the current stack.

      -

      Parameters

      • obj: any

      Returns any

    toJsonString

    • toJsonString(obj: any, space?: number): string

    • Convert an object, potentially containing tokens, to a JSON string

      -

      Parameters

      • obj: any
      • Optionalspace: number

      Returns string

    toYamlString

    • toYamlString(obj: any): string

    • Convert an object, potentially containing tokens, to a YAML string

      -

      Parameters

      • obj: any

      Returns string

    reportMissingContextKey

    • reportMissingContextKey(report: MissingContext): void

    • Indicate that a context key was expected

      -

      Contains instructions which will be emitted into the cloud assembly on how -the key should be supplied.

      -

      Parameters

      • report: MissingContext

        The set of parameters needed to obtain the context

        -

      Returns void

    renameLogicalId

    • renameLogicalId(oldId: string, newId: string): void

    • Rename a generated logical identities

      -

      To modify the naming scheme strategy, extend the Stack class and -override the allocateLogicalId method.

      -

      Parameters

      • oldId: string
      • newId: string

      Returns void

    getLogicalId

    • getLogicalId(element: CfnElement): string

    • Allocates a stack-unique CloudFormation-compatible logical identity for a -specific resource.

      -

      This method is called when a CfnElement is created and used to render the -initial logical identity of resources. Logical ID renames are applied at -this stage.

      -

      This method uses the protected method allocateLogicalId to render the -logical ID for an element. To modify the naming scheme, extend the Stack -class and override this method.

      -

      Parameters

      • element: CfnElement

        The CloudFormation element for which a logical identity is -needed.

        -

      Returns string

    addDependency

    • addDependency(target: Stack, reason?: string): void

    • Add a dependency between this stack and another stack.

      -

      This can be used to define dependencies between any two stacks within an -app, and also supports nested stacks.

      -

      Parameters

      • target: Stack
      • Optionalreason: string

      Returns void

    formatArn

    • formatArn(components: ArnComponents): string

    • Creates an ARN from components.

      -

      If partition, region or account are not specified, the stack's -partition, region and account will be used.

      -

      If any component is the empty string, an empty string will be inserted -into the generated ARN at the location that component corresponds to.

      -

      The ARN will be formatted as follows:

      -

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      -

      The required ARN pieces that are omitted will be taken from the stack that -the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope -can be 'undefined'.

      -

      Parameters

      • components: ArnComponents

      Returns string

    splitArn

    • splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

    • Splits the provided ARN into its components. -Works both if 'arn' is a string like 'arn:aws:s3:::bucket', -and a Token representing a dynamic CloudFormation expression -(in which case the returned components will also be dynamic CloudFormation expressions, -encoded as Tokens).

      -

      Parameters

      • arn: string

        the ARN to split into its components

        -
      • arnFormat: ArnFormat

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        -

      Returns ArnComponents

    addTransform

    • addTransform(transform: string): void

    • Add a Transform to this stack. A Transform is a macro that AWS -CloudFormation uses to process your template.

      -

      Duplicate values are removed when stack is synthesized.

      -

      Parameters

      • transform: string

        The transform to add

        -

      Returns void

      See

      https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

      -

      Example

      declare const stack: Stack;

      stack.addTransform('AWS::Serverless-2016-10-31')
-
      - -

    addMetadata

    _addAssemblyDependency

    • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
    • Internal

      Called implicitly by the addDependency helper function in order to -realize a dependency between two top-level stacks at the assembly level.

      -

      Use stack.addDependency to define the dependency between any two stacks, -and take into account nested stack relationships.

      -

      Parameters

      • target: Stack
      • Optionalreason: StackDependencyReason

      Returns void

    _obtainAssemblyDependencies

    • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
    • Internal

      Called implicitly by the obtainDependencies helper function in order to -collect resource dependencies across two top-level stacks at the assembly level.

      -

      Use stack.obtainDependencies to see the dependencies between any two stacks.

      -

      Parameters

      • reasonFilter: StackDependencyReason

      Returns Element[]

    _removeAssemblyDependency

    • _removeAssemblyDependency(
          target: Stack,
          reasonFilter?: StackDependencyReason,
      ): void
    • Internal

      Called implicitly by the removeDependency helper function in order to -remove a dependency between two top-level stacks at the assembly level.

      -

      Use stack.addDependency to define the dependency between any two stacks, -and take into account nested stack relationships.

      -

      Parameters

      • target: Stack
      • OptionalreasonFilter: StackDependencyReason

      Returns void

    _synthesizeTemplate

    • _synthesizeTemplate(
          session: ISynthesisSession,
          lookupRoleArn?: string,
          lookupRoleExternalId?: string,
          lookupRoleAdditionalOptions?: { [key: string]: any },
      ): void
    • Internal

      Synthesizes the cloudformation template into a cloud assembly.

      -

      Parameters

      • session: ISynthesisSession
      • OptionallookupRoleArn: string
      • OptionallookupRoleExternalId: string
      • OptionallookupRoleAdditionalOptions: { [key: string]: any }

      Returns void

    regionalFact

    • regionalFact(factName: string, defaultValue?: string): string

    • Look up a fact value for the given fact for the region of this stack

      -

      Will return a definite value only if the region of the current stack is resolved. -If not, a lookup map will be added to the stack and the lookup will be done at -CDK deployment time.

      -

      What regions will be included in the lookup map is controlled by the -@aws-cdk/core:target-partitions context value: it must be set to a list -of partitions, and only regions from the given partitions will be included. -If no such context key is set, all regions will be included.

      -

      This function is intended to be used by construct library authors. Application -builders can rely on the abstractions offered by construct libraries and do -not have to worry about regional facts.

      -

      If defaultValue is not given, it is an error if the fact is unknown for -the given region.

      -

      Parameters

      • factName: string
      • OptionaldefaultValue: string

      Returns string

    exportValue

    • exportValue(exportedValue: any, options?: ExportValueOptions): string

    • Create a CloudFormation Export for a string value

      -

      Returns a string representing the corresponding Fn.importValue() -expression for this Export. You can control the name for the export by -passing the name option.

      -

      If you don't supply a value for name, the value you're exporting must be -a Resource attribute (for example: bucket.bucketName) and it will be -given the same name as the automatic cross-stack reference that would be created -if you used the attribute in another Stack.

      -

      One of the uses for this method is to remove the relationship between -two Stacks established by automatic cross-stack references. It will -temporarily ensure that the CloudFormation Export still exists while you -remove the reference from the consuming stack. After that, you can remove -the resource and the manual export.

      -

      Here is how the process works. Let's say there are two stacks, -producerStack and consumerStack, and producerStack has a bucket -called bucket, which is referenced by consumerStack (perhaps because -an AWS Lambda Function writes into it, or something like that).

      -

      It is not safe to remove producerStack.bucket because as the bucket is being -deleted, consumerStack might still be using it.

      -

      Instead, the process takes two deployments:

      -

      Deployment 1: break the relationship:

      -
        -
      • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer -stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just -remove the Lambda Function altogether).
        • -
      • In the ProducerStack class, call this.exportValue(this.bucket.bucketName). This -will make sure the CloudFormation Export continues to exist while the relationship -between the two stacks is being broken.
        • -
      • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).
        • -
      -

      Deployment 2: remove the bucket resource:

      -
        -
      • You are now free to remove the bucket resource from producerStack.
        • -
      • Don't forget to remove the exportValue() call as well.
        • -
      • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
        • -
      -

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string

    exportStringListValue

    • exportStringListValue(
          exportedValue: any,
          options?: ExportValueOptions,
      ): string[]

    • Create a CloudFormation Export for a string list value

      -

      Returns a string list representing the corresponding Fn.importValue() -expression for this Export. The export expression is automatically wrapped with an -Fn::Join and the import value with an Fn::Split, since CloudFormation can only -export strings. You can control the name for the export by passing the name option.

      -

      If you don't supply a value for name, the value you're exporting must be -a Resource attribute (for example: bucket.bucketName) and it will be -given the same name as the automatic cross-stack reference that would be created -if you used the attribute in another Stack.

      -

      One of the uses for this method is to remove the relationship between -two Stacks established by automatic cross-stack references. It will -temporarily ensure that the CloudFormation Export still exists while you -remove the reference from the consuming stack. After that, you can remove -the resource and the manual export.

      -

      See exportValue for an example of this process.

      -

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string[]

    ProtectedallocateLogicalId

    • allocateLogicalId(cfnElement: CfnElement): string

    • Returns the naming scheme used to allocate logical IDs. By default, uses -the HashedAddressingScheme but this method can be overridden to customize -this behavior.

      -

      In order to make sure logical IDs are unique and stable, we hash the resource -construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as -a suffix to the path components joined without a separator (CloudFormation -IDs only allow alphanumeric characters).

      -

      The result will be:

      -

      <path.join('')><md5(path.join('/')> -"human" "hash"

      -

      If the "human" part of the ID exceeds 240 characters, we simply trim it so -the total ID doesn't exceed CloudFormation's 255 character limit.

      -

      We only take 8 characters from the md5 hash (0.000005 chance of collision).

      -

      Special cases:

      -
        -
      • If the path only contains a single component (i.e. it's a top-level -resource), we won't add the hash to it. The hash is not needed for -disambiguation and also, it allows for a more straightforward migration an -existing CloudFormation template to a CDK stack without logical ID changes -(or renames).
        • -
      • For aesthetic reasons, if the last components of the path are the same -(i.e. L1/L2/Pipeline/Pipeline), they will be de-duplicated to make the -resulting human portion of the ID more pleasing: L1L2Pipeline<HASH> -instead of L1L2PipelinePipeline<HASH>
        • -
      • If a component is named "Default" it will be omitted from the path. This -allows refactoring higher level abstractions around constructs without affecting -the IDs of already deployed resources.
        • -
      • If a component is named "Resource" it will be omitted from the user-visible -path, but included in the hash. This reduces visual noise in the human readable -part of the identifier.
        • -
      -

      Parameters

      • cfnElement: CfnElement

        The element for which the logical ID is allocated.

        -

      Returns string

    Protected_validateId

    • _validateId(name: string): void
    • Internal

      Validate stack name

      -

      CloudFormation stack names can include dashes in addition to the regular identifier -character classes, and we don't allow one of the magic markers.

      -

      Parameters

      • name: string

      Returns void

    Protected_toCloudFormation

    • _toCloudFormation(): any
    • Internal

      Returns the CloudFormation template for this stack by traversing -the tree and invoking _toCloudFormation() on all Entity objects.

      -

      Returns any

    StaticisConstruct

    • isConstruct(x: any): x is Construct

    • Checks if x is a construct.

      -

      Use this method instead of instanceof to properly detect Construct -instances, even when the construct library is symlinked.

      -

      Explanation: in JavaScript, multiple copies of the constructs library on -disk are seen as independent, completely different libraries. As a -consequence, the class Construct in each copy of the constructs library -is seen as a different class, and an instance of one class will not test as -instanceof the other class. npm install will not create installations -like this, but users may manually symlink construct libraries together or -use a monorepo tool: in those cases, multiple copies of the constructs -library can be accidentally installed, and instanceof will behave -unpredictably. It is safest to avoid using instanceof, and using -this type-testing method instead.

      -

      Parameters

      • x: any

        Any object

        -

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

      -

    toString

    • toString(): string

    • Returns a string representation of this construct.

      -

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/PipelineNetworkStack.html b/classes/PipelineNetworkStack.html deleted file mode 100644 index 0e816f9..0000000 --- a/classes/PipelineNetworkStack.html +++ /dev/null @@ -1,327 +0,0 @@ -PipelineNetworkStack | aws4embeddedlinux-cdk-lib

    Class PipelineNetworkStack

    The network resources to run the pipeline in.

    -

    This stack is provided for when users do not have an existing VPC with -private and public subnets for the pipeline.

    -

    Hierarchy

    • Stack
      • PipelineNetworkStack

    Constructors

    constructor -

    Properties

    vpc -tags -templateOptions -region -account -environment -nestedStackResource? -templateFile -artifactId -synthesizer -_versionReportingEnabled -_crossRegionReferences -_notificationArns? -node -

    Accessors

    terminationProtection -dependencies -stackName -partition -urlSuffix -stackId -notificationArns -nested -availabilityZones -nestedStackParent -bundlingRequired -

    Methods

    isStack -of -resolve -toJsonString -toYamlString -reportMissingContextKey -renameLogicalId -getLogicalId -addDependency -formatArn -splitArn -addTransform -addMetadata -_addAssemblyDependency -_obtainAssemblyDependencies -_removeAssemblyDependency -_synthesizeTemplate -regionalFact -exportValue -exportStringListValue -allocateLogicalId -_validateId -_toCloudFormation -isConstruct -toString -

    Constructors

    constructor

    Properties

    Readonlyvpc

    vpc: IVpc

    The VPC for the pipeline to reside in.

    -

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    -

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    -

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    -

    This value is resolved according to the following rules:

    -
      -
    1. The value provided to env.region when the stack is defined. This can -either be a concrete region (e.g. us-west-2) or the Aws.REGION -token.
      2. -
    2. Aws.REGION, which is represents the CloudFormation intrinsic reference -{ "Ref": "AWS::Region" } encoded as a string token.
      3. -
    -

    Preferably, you should use the return value as an opaque string and not -attempt to parse it to implement your logic. If you do, you must first -check that it is a concrete value an not an unresolved token. If this -value is an unresolved token (Token.isUnresolved(stack.region) returns -true), this implies that the user wishes that this stack will synthesize -into a region-agnostic template. In this case, your code should either -fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or -implement some other region-agnostic behavior.

    -

    Readonlyaccount

    account: string

    The AWS account into which this stack will be deployed.

    -

    This value is resolved according to the following rules:

    -
      -
    1. The value provided to env.account when the stack is defined. This can -either be a concrete account (e.g. 585695031111) or the -Aws.ACCOUNT_ID token.
      2. -
    2. Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference -{ "Ref": "AWS::AccountId" } encoded as a string token.
      3. -
    -

    Preferably, you should use the return value as an opaque string and not -attempt to parse it to implement your logic. If you do, you must first -check that it is a concrete value an not an unresolved token. If this -value is an unresolved token (Token.isUnresolved(stack.account) returns -true), this implies that the user wishes that this stack will synthesize -into a account-agnostic template. In this case, your code should either -fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or -implement some other region-agnostic behavior.

    -

    Readonlyenvironment

    environment: string

    The environment coordinates in which this stack is deployed. In the form -aws://account/region. Use stack.account and stack.region to obtain -the specific values, no need to parse.

    -

    You can use this value to determine if two stacks are targeting the same -environment.

    -

    If either stack.account or stack.region are not concrete values (e.g. -Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or -unknown-region will be used respectively to indicate this stack is -region/account-agnostic.

    -

    Optional ReadonlynestedStackResource

    nestedStackResource?: CfnResource

    If this is a nested stack, this represents its AWS::CloudFormation::Stack -resource. undefined for top-level (non-nested) stacks.

    -

    ReadonlytemplateFile

    templateFile: string

    The name of the CloudFormation template file emitted to the output -directory during synthesis.

    -

    Example value: MyStack.template.json

    -

    ReadonlyartifactId

    artifactId: string

    The ID of the cloud assembly artifact for this stack.

    -

    Readonlysynthesizer

    synthesizer: IStackSynthesizer

    Synthesis method for this stack

    -

    Readonly Internal_versionReportingEnabled

    _versionReportingEnabled: boolean

    Whether version reporting is enabled for this stack

    -

    Controls whether the CDK Metadata resource is injected

    -

    Readonly Internal_crossRegionReferences

    _crossRegionReferences: boolean

    Whether cross region references are enabled for this stack

    -

    Optional Readonly Internal_notificationArns

    _notificationArns?: string[]

    SNS Notification ARNs to receive stack events.

    -

    Readonlynode

    node: Node

    The tree node.

    -

    Accessors

    terminationProtection

    • get terminationProtection(): boolean

    • Whether termination protection is enabled for this stack.

      -

      Returns boolean

    • set terminationProtection(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    dependencies

    • get dependencies(): Stack[]

    • Return the stacks this stack depends on

      -

      Returns Stack[]

    stackName

    • get stackName(): string

    • The concrete CloudFormation physical stack name.

      -

      This is either the name defined explicitly in the stackName prop or -allocated based on the stack's location in the construct tree. Stacks that -are directly defined under the app use their construct id as their stack -name. Stacks that are defined deeper within the tree will use a hashed naming -scheme based on the construct path to ensure uniqueness.

      -

      If you wish to obtain the deploy-time AWS::StackName intrinsic, -you can use Aws.STACK_NAME directly.

      -

      Returns string

    partition

    • get partition(): string

    • The partition in which this stack is defined

      -

      Returns string

    urlSuffix

    • get urlSuffix(): string

    • The Amazon domain suffix for the region in which this stack is defined

      -

      Returns string

    stackId

    • get stackId(): string

    • The ID of the stack

      -

      Returns string

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
-
      - -

    notificationArns

    • get notificationArns(): string[]

    • Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      -

      Returns string[]

    nested

    • get nested(): boolean

    • Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      -

      Returns boolean

    availabilityZones

    • get availabilityZones(): string[]

    • Returns the list of AZs that are available in the AWS environment -(account/region) associated with this stack.

      -

      If the stack is environment-agnostic (either account and/or region are -tokens), this property will return an array with 2 tokens that will resolve -at deploy-time to the first two availability zones returned from CloudFormation's -Fn::GetAZs intrinsic function.

      -

      If they are not available in the context, returns a set of dummy values and -reports them as missing, and let the CLI resolve them by calling EC2 -DescribeAvailabilityZones on the target environment.

      -

      To specify a different strategy for selecting availability zones override this method.

      -

      Returns string[]

    nestedStackParent

    • get nestedStackParent(): undefined | Stack

    • If this is a nested stack, returns it's parent stack.

      -

      Returns undefined | Stack

    bundlingRequired

    • get bundlingRequired(): boolean

    • Indicates whether the stack requires bundling or not

      -

      Returns boolean

    Methods

    StaticisStack

    • isStack(x: any): x is Stack

    • Return whether the given object is a Stack.

      -

      We do attribute detection since we can't reliably use 'instanceof'.

      -

      Parameters

      • x: any

      Returns x is Stack

    Staticof

    • of(construct: IConstruct): Stack

    • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      -

      Parameters

      • construct: IConstruct

        The construct to start the search from.

        -

      Returns Stack

    resolve

    • resolve(obj: any): any

    • Resolve a tokenized value in the context of the current stack.

      -

      Parameters

      • obj: any

      Returns any

    toJsonString

    • toJsonString(obj: any, space?: number): string

    • Convert an object, potentially containing tokens, to a JSON string

      -

      Parameters

      • obj: any
      • Optionalspace: number

      Returns string

    toYamlString

    • toYamlString(obj: any): string

    • Convert an object, potentially containing tokens, to a YAML string

      -

      Parameters

      • obj: any

      Returns string

    reportMissingContextKey

    • reportMissingContextKey(report: MissingContext): void

    • Indicate that a context key was expected

      -

      Contains instructions which will be emitted into the cloud assembly on how -the key should be supplied.

      -

      Parameters

      • report: MissingContext

        The set of parameters needed to obtain the context

        -

      Returns void

    renameLogicalId

    • renameLogicalId(oldId: string, newId: string): void

    • Rename a generated logical identities

      -

      To modify the naming scheme strategy, extend the Stack class and -override the allocateLogicalId method.

      -

      Parameters

      • oldId: string
      • newId: string

      Returns void

    getLogicalId

    • getLogicalId(element: CfnElement): string

    • Allocates a stack-unique CloudFormation-compatible logical identity for a -specific resource.

      -

      This method is called when a CfnElement is created and used to render the -initial logical identity of resources. Logical ID renames are applied at -this stage.

      -

      This method uses the protected method allocateLogicalId to render the -logical ID for an element. To modify the naming scheme, extend the Stack -class and override this method.

      -

      Parameters

      • element: CfnElement

        The CloudFormation element for which a logical identity is -needed.

        -

      Returns string

    addDependency

    • addDependency(target: Stack, reason?: string): void

    • Add a dependency between this stack and another stack.

      -

      This can be used to define dependencies between any two stacks within an -app, and also supports nested stacks.

      -

      Parameters

      • target: Stack
      • Optionalreason: string

      Returns void

    formatArn

    • formatArn(components: ArnComponents): string

    • Creates an ARN from components.

      -

      If partition, region or account are not specified, the stack's -partition, region and account will be used.

      -

      If any component is the empty string, an empty string will be inserted -into the generated ARN at the location that component corresponds to.

      -

      The ARN will be formatted as follows:

      -

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      -

      The required ARN pieces that are omitted will be taken from the stack that -the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope -can be 'undefined'.

      -

      Parameters

      • components: ArnComponents

      Returns string

    splitArn

    • splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

    • Splits the provided ARN into its components. -Works both if 'arn' is a string like 'arn:aws:s3:::bucket', -and a Token representing a dynamic CloudFormation expression -(in which case the returned components will also be dynamic CloudFormation expressions, -encoded as Tokens).

      -

      Parameters

      • arn: string

        the ARN to split into its components

        -
      • arnFormat: ArnFormat

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        -

      Returns ArnComponents

    addTransform

    • addTransform(transform: string): void

    • Add a Transform to this stack. A Transform is a macro that AWS -CloudFormation uses to process your template.

      -

      Duplicate values are removed when stack is synthesized.

      -

      Parameters

      • transform: string

        The transform to add

        -

      Returns void

      See

      https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

      -

      Example

      declare const stack: Stack;

      stack.addTransform('AWS::Serverless-2016-10-31')
-
      - -

    addMetadata

    _addAssemblyDependency

    • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
    • Internal

      Called implicitly by the addDependency helper function in order to -realize a dependency between two top-level stacks at the assembly level.

      -

      Use stack.addDependency to define the dependency between any two stacks, -and take into account nested stack relationships.

      -

      Parameters

      • target: Stack
      • Optionalreason: StackDependencyReason

      Returns void

    _obtainAssemblyDependencies

    • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
    • Internal

      Called implicitly by the obtainDependencies helper function in order to -collect resource dependencies across two top-level stacks at the assembly level.

      -

      Use stack.obtainDependencies to see the dependencies between any two stacks.

      -

      Parameters

      • reasonFilter: StackDependencyReason

      Returns Element[]

    _removeAssemblyDependency

    • _removeAssemblyDependency(
          target: Stack,
          reasonFilter?: StackDependencyReason,
      ): void
    • Internal

      Called implicitly by the removeDependency helper function in order to -remove a dependency between two top-level stacks at the assembly level.

      -

      Use stack.addDependency to define the dependency between any two stacks, -and take into account nested stack relationships.

      -

      Parameters

      • target: Stack
      • OptionalreasonFilter: StackDependencyReason

      Returns void

    _synthesizeTemplate

    • _synthesizeTemplate(
          session: ISynthesisSession,
          lookupRoleArn?: string,
          lookupRoleExternalId?: string,
          lookupRoleAdditionalOptions?: { [key: string]: any },
      ): void
    • Internal

      Synthesizes the cloudformation template into a cloud assembly.

      -

      Parameters

      • session: ISynthesisSession
      • OptionallookupRoleArn: string
      • OptionallookupRoleExternalId: string
      • OptionallookupRoleAdditionalOptions: { [key: string]: any }

      Returns void

    regionalFact

    • regionalFact(factName: string, defaultValue?: string): string

    • Look up a fact value for the given fact for the region of this stack

      -

      Will return a definite value only if the region of the current stack is resolved. -If not, a lookup map will be added to the stack and the lookup will be done at -CDK deployment time.

      -

      What regions will be included in the lookup map is controlled by the -@aws-cdk/core:target-partitions context value: it must be set to a list -of partitions, and only regions from the given partitions will be included. -If no such context key is set, all regions will be included.

      -

      This function is intended to be used by construct library authors. Application -builders can rely on the abstractions offered by construct libraries and do -not have to worry about regional facts.

      -

      If defaultValue is not given, it is an error if the fact is unknown for -the given region.

      -

      Parameters

      • factName: string
      • OptionaldefaultValue: string

      Returns string

    exportValue

    • exportValue(exportedValue: any, options?: ExportValueOptions): string

    • Create a CloudFormation Export for a string value

      -

      Returns a string representing the corresponding Fn.importValue() -expression for this Export. You can control the name for the export by -passing the name option.

      -

      If you don't supply a value for name, the value you're exporting must be -a Resource attribute (for example: bucket.bucketName) and it will be -given the same name as the automatic cross-stack reference that would be created -if you used the attribute in another Stack.

      -

      One of the uses for this method is to remove the relationship between -two Stacks established by automatic cross-stack references. It will -temporarily ensure that the CloudFormation Export still exists while you -remove the reference from the consuming stack. After that, you can remove -the resource and the manual export.

      -

      Here is how the process works. Let's say there are two stacks, -producerStack and consumerStack, and producerStack has a bucket -called bucket, which is referenced by consumerStack (perhaps because -an AWS Lambda Function writes into it, or something like that).

      -

      It is not safe to remove producerStack.bucket because as the bucket is being -deleted, consumerStack might still be using it.

      -

      Instead, the process takes two deployments:

      -

      Deployment 1: break the relationship:

      -
        -
      • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer -stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just -remove the Lambda Function altogether).
        • -
      • In the ProducerStack class, call this.exportValue(this.bucket.bucketName). This -will make sure the CloudFormation Export continues to exist while the relationship -between the two stacks is being broken.
        • -
      • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).
        • -
      -

      Deployment 2: remove the bucket resource:

      -
        -
      • You are now free to remove the bucket resource from producerStack.
        • -
      • Don't forget to remove the exportValue() call as well.
        • -
      • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
        • -
      -

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string

    exportStringListValue

    • exportStringListValue(
          exportedValue: any,
          options?: ExportValueOptions,
      ): string[]

    • Create a CloudFormation Export for a string list value

      -

      Returns a string list representing the corresponding Fn.importValue() -expression for this Export. The export expression is automatically wrapped with an -Fn::Join and the import value with an Fn::Split, since CloudFormation can only -export strings. You can control the name for the export by passing the name option.

      -

      If you don't supply a value for name, the value you're exporting must be -a Resource attribute (for example: bucket.bucketName) and it will be -given the same name as the automatic cross-stack reference that would be created -if you used the attribute in another Stack.

      -

      One of the uses for this method is to remove the relationship between -two Stacks established by automatic cross-stack references. It will -temporarily ensure that the CloudFormation Export still exists while you -remove the reference from the consuming stack. After that, you can remove -the resource and the manual export.

      -

      See exportValue for an example of this process.

      -

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string[]

    ProtectedallocateLogicalId

    • allocateLogicalId(cfnElement: CfnElement): string

    • Returns the naming scheme used to allocate logical IDs. By default, uses -the HashedAddressingScheme but this method can be overridden to customize -this behavior.

      -

      In order to make sure logical IDs are unique and stable, we hash the resource -construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as -a suffix to the path components joined without a separator (CloudFormation -IDs only allow alphanumeric characters).

      -

      The result will be:

      -

      <path.join('')><md5(path.join('/')> -"human" "hash"

      -

      If the "human" part of the ID exceeds 240 characters, we simply trim it so -the total ID doesn't exceed CloudFormation's 255 character limit.

      -

      We only take 8 characters from the md5 hash (0.000005 chance of collision).

      -

      Special cases:

      -
        -
      • If the path only contains a single component (i.e. it's a top-level -resource), we won't add the hash to it. The hash is not needed for -disambiguation and also, it allows for a more straightforward migration an -existing CloudFormation template to a CDK stack without logical ID changes -(or renames).
        • -
      • For aesthetic reasons, if the last components of the path are the same -(i.e. L1/L2/Pipeline/Pipeline), they will be de-duplicated to make the -resulting human portion of the ID more pleasing: L1L2Pipeline<HASH> -instead of L1L2PipelinePipeline<HASH>
        • -
      • If a component is named "Default" it will be omitted from the path. This -allows refactoring higher level abstractions around constructs without affecting -the IDs of already deployed resources.
        • -
      • If a component is named "Resource" it will be omitted from the user-visible -path, but included in the hash. This reduces visual noise in the human readable -part of the identifier.
        • -
      -

      Parameters

      • cfnElement: CfnElement

        The element for which the logical ID is allocated.

        -

      Returns string

    Protected_validateId

    • _validateId(name: string): void
    • Internal

      Validate stack name

      -

      CloudFormation stack names can include dashes in addition to the regular identifier -character classes, and we don't allow one of the magic markers.

      -

      Parameters

      • name: string

      Returns void

    Protected_toCloudFormation

    • _toCloudFormation(): any
    • Internal

      Returns the CloudFormation template for this stack by traversing -the tree and invoking _toCloudFormation() on all Entity objects.

      -

      Returns any

    StaticisConstruct

    • isConstruct(x: any): x is Construct

    • Checks if x is a construct.

      -

      Use this method instead of instanceof to properly detect Construct -instances, even when the construct library is symlinked.

      -

      Explanation: in JavaScript, multiple copies of the constructs library on -disk are seen as independent, completely different libraries. As a -consequence, the class Construct in each copy of the constructs library -is seen as a different class, and an instance of one class will not test as -instanceof the other class. npm install will not create installations -like this, but users may manually symlink construct libraries together or -use a monorepo tool: in those cases, multiple copies of the constructs -library can be accidentally installed, and instanceof will behave -unpredictably. It is safest to avoid using instanceof, and using -this type-testing method instead.

      -

      Parameters

      • x: any

        Any object

        -

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

      -

    toString

    • toString(): string

    • Returns a string representation of this construct.

      -

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/PipelineResourcesStack.html b/classes/PipelineResourcesStack.html new file mode 100644 index 0000000..deb1d81 --- /dev/null +++ b/classes/PipelineResourcesStack.html @@ -0,0 +1,337 @@ +PipelineResourcesStack | aws4embeddedlinux-cdk-lib

    Class PipelineResourcesStack

    Input (Source) data for our PipelineResourcesStack.

    +

    Hierarchy

    • Stack
      • PipelineResourcesStack

    Constructors

    constructor +

    Properties

    vpc +ecrRepository +pipelineArtifactBucket +pipelineSourceBucket +pipelineOutputBucket +loggingBucket? +encryptionKey +tags +templateOptions +region +account +environment +nestedStackResource? +templateFile +artifactId +synthesizer +_versionReportingEnabled +_crossRegionReferences +_notificationArns? +node +

    Accessors

    terminationProtection +dependencies +stackName +partition +urlSuffix +stackId +notificationArns +nested +availabilityZones +nestedStackParent +bundlingRequired +

    Methods

    isStack +of +resolve +toJsonString +toYamlString +reportMissingContextKey +renameLogicalId +getLogicalId +addDependency +formatArn +splitArn +addTransform +addMetadata +_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate +regionalFact +exportValue +exportStringListValue +allocateLogicalId +_validateId +_toCloudFormation +isConstruct +toString +

    Constructors

    constructor

    Properties

    Readonlyvpc

    vpc: IVpc

    The VPC for the pipeline to reside in.

    +

    ReadonlyecrRepository

    ecrRepository: IRepository

    The respository to put the build host container in.

    +

    ReadonlypipelineArtifactBucket

    pipelineArtifactBucket: Bucket

    The artifact bucket

    +

    ReadonlypipelineSourceBucket

    pipelineSourceBucket: Bucket

    The source bucket

    +

    ReadonlypipelineOutputBucket

    pipelineOutputBucket: Bucket

    The output bucket

    +

    Optional ReadonlyloggingBucket

    loggingBucket?: Bucket

    The Cloudwatch logging bucket

    +

    ReadonlyencryptionKey

    encryptionKey: Key

    The encryption key use across

    +

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    +

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    +

    This value is resolved according to the following rules:

    +
      +
    1. The value provided to env.region when the stack is defined. This can +either be a concrete region (e.g. us-west-2) or the Aws.REGION +token.
      2. +
    2. Aws.REGION, which is represents the CloudFormation intrinsic reference +{ "Ref": "AWS::Region" } encoded as a string token.
      3. +
    +

    Preferably, you should use the return value as an opaque string and not +attempt to parse it to implement your logic. If you do, you must first +check that it is a concrete value an not an unresolved token. If this +value is an unresolved token (Token.isUnresolved(stack.region) returns +true), this implies that the user wishes that this stack will synthesize +into a region-agnostic template. In this case, your code should either +fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or +implement some other region-agnostic behavior.

    +

    Readonlyaccount

    account: string

    The AWS account into which this stack will be deployed.

    +

    This value is resolved according to the following rules:

    +
      +
    1. The value provided to env.account when the stack is defined. This can +either be a concrete account (e.g. 585695031111) or the +Aws.ACCOUNT_ID token.
      2. +
    2. Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference +{ "Ref": "AWS::AccountId" } encoded as a string token.
      3. +
    +

    Preferably, you should use the return value as an opaque string and not +attempt to parse it to implement your logic. If you do, you must first +check that it is a concrete value an not an unresolved token. If this +value is an unresolved token (Token.isUnresolved(stack.account) returns +true), this implies that the user wishes that this stack will synthesize +into a account-agnostic template. In this case, your code should either +fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or +implement some other region-agnostic behavior.

    +

    Readonlyenvironment

    environment: string

    The environment coordinates in which this stack is deployed. In the form +aws://account/region. Use stack.account and stack.region to obtain +the specific values, no need to parse.

    +

    You can use this value to determine if two stacks are targeting the same +environment.

    +

    If either stack.account or stack.region are not concrete values (e.g. +Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or +unknown-region will be used respectively to indicate this stack is +region/account-agnostic.

    +

    Optional ReadonlynestedStackResource

    nestedStackResource?: CfnResource

    If this is a nested stack, this represents its AWS::CloudFormation::Stack +resource. undefined for top-level (non-nested) stacks.

    +

    ReadonlytemplateFile

    templateFile: string

    The name of the CloudFormation template file emitted to the output +directory during synthesis.

    +

    Example value: MyStack.template.json

    +

    ReadonlyartifactId

    artifactId: string

    The ID of the cloud assembly artifact for this stack.

    +

    Readonlysynthesizer

    synthesizer: IStackSynthesizer

    Synthesis method for this stack

    +

    Readonly Internal_versionReportingEnabled

    _versionReportingEnabled: boolean

    Whether version reporting is enabled for this stack

    +

    Controls whether the CDK Metadata resource is injected

    +

    Readonly Internal_crossRegionReferences

    _crossRegionReferences: boolean

    Whether cross region references are enabled for this stack

    +

    Optional Readonly Internal_notificationArns

    _notificationArns?: string[]

    SNS Notification ARNs to receive stack events.

    +

    Readonlynode

    node: Node

    The tree node.

    +

    Accessors

    terminationProtection

    • get terminationProtection(): boolean

      Whether termination protection is enabled for this stack.

      +

      Returns boolean

    • set terminationProtection(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    dependencies

    • get dependencies(): Stack[]

      Return the stacks this stack depends on

      +

      Returns Stack[]

    stackName

    • get stackName(): string

      The concrete CloudFormation physical stack name.

      +

      This is either the name defined explicitly in the stackName prop or +allocated based on the stack's location in the construct tree. Stacks that +are directly defined under the app use their construct id as their stack +name. Stacks that are defined deeper within the tree will use a hashed naming +scheme based on the construct path to ensure uniqueness.

      +

      If you wish to obtain the deploy-time AWS::StackName intrinsic, +you can use Aws.STACK_NAME directly.

      +

      Returns string

    partition

    • get partition(): string

      The partition in which this stack is defined

      +

      Returns string

    urlSuffix

    • get urlSuffix(): string

      The Amazon domain suffix for the region in which this stack is defined

      +

      Returns string

    stackId

    • get stackId(): string

      The ID of the stack

      +

      Returns string

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+
      + +

    notificationArns

    • get notificationArns(): string[]

      Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      +

      Returns string[]

    nested

    • get nested(): boolean

      Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      +

      Returns boolean

    availabilityZones

    • get availabilityZones(): string[]

      Returns the list of AZs that are available in the AWS environment +(account/region) associated with this stack.

      +

      If the stack is environment-agnostic (either account and/or region are +tokens), this property will return an array with 2 tokens that will resolve +at deploy-time to the first two availability zones returned from CloudFormation's +Fn::GetAZs intrinsic function.

      +

      If they are not available in the context, returns a set of dummy values and +reports them as missing, and let the CLI resolve them by calling EC2 +DescribeAvailabilityZones on the target environment.

      +

      To specify a different strategy for selecting availability zones override this method.

      +

      Returns string[]

    nestedStackParent

    • get nestedStackParent(): undefined | Stack

      If this is a nested stack, returns it's parent stack.

      +

      Returns undefined | Stack

    bundlingRequired

    • get bundlingRequired(): boolean

      Indicates whether the stack requires bundling or not

      +

      Returns boolean

    Methods

    StaticisStack

    • isStack(x: any): x is Stack

      Return whether the given object is a Stack.

      +

      We do attribute detection since we can't reliably use 'instanceof'.

      +

      Parameters

      • x: any

      Returns x is Stack

    Staticof

    • of(construct: IConstruct): Stack

      Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      +

      Parameters

      • construct: IConstruct

        The construct to start the search from.

        +

      Returns Stack

    resolve

    • resolve(obj: any): any

      Resolve a tokenized value in the context of the current stack.

      +

      Parameters

      • obj: any

      Returns any

    toJsonString

    • toJsonString(obj: any, space?: number): string

      Convert an object, potentially containing tokens, to a JSON string

      +

      Parameters

      • obj: any
      • Optionalspace: number

      Returns string

    toYamlString

    • toYamlString(obj: any): string

      Convert an object, potentially containing tokens, to a YAML string

      +

      Parameters

      • obj: any

      Returns string

    reportMissingContextKey

    • reportMissingContextKey(report: MissingContext): void

      Indicate that a context key was expected

      +

      Contains instructions which will be emitted into the cloud assembly on how +the key should be supplied.

      +

      Parameters

      • report: MissingContext

        The set of parameters needed to obtain the context

        +

      Returns void

    renameLogicalId

    • renameLogicalId(oldId: string, newId: string): void

      Rename a generated logical identities

      +

      To modify the naming scheme strategy, extend the Stack class and +override the allocateLogicalId method.

      +

      Parameters

      • oldId: string
      • newId: string

      Returns void

    getLogicalId

    • getLogicalId(element: CfnElement): string

      Allocates a stack-unique CloudFormation-compatible logical identity for a +specific resource.

      +

      This method is called when a CfnElement is created and used to render the +initial logical identity of resources. Logical ID renames are applied at +this stage.

      +

      This method uses the protected method allocateLogicalId to render the +logical ID for an element. To modify the naming scheme, extend the Stack +class and override this method.

      +

      Parameters

      • element: CfnElement

        The CloudFormation element for which a logical identity is +needed.

        +

      Returns string

    addDependency

    • addDependency(target: Stack, reason?: string): void

      Add a dependency between this stack and another stack.

      +

      This can be used to define dependencies between any two stacks within an +app, and also supports nested stacks.

      +

      Parameters

      • target: Stack
      • Optionalreason: string

      Returns void

    formatArn

    • formatArn(components: ArnComponents): string

      Creates an ARN from components.

      +

      If partition, region or account are not specified, the stack's +partition, region and account will be used.

      +

      If any component is the empty string, an empty string will be inserted +into the generated ARN at the location that component corresponds to.

      +

      The ARN will be formatted as follows:

      +

      arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

      +

      The required ARN pieces that are omitted will be taken from the stack that +the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope +can be 'undefined'.

      +

      Parameters

      • components: ArnComponents

      Returns string

    splitArn

    • splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

      Splits the provided ARN into its components. +Works both if 'arn' is a string like 'arn:aws:s3:::bucket', +and a Token representing a dynamic CloudFormation expression +(in which case the returned components will also be dynamic CloudFormation expressions, +encoded as Tokens).

      +

      Parameters

      • arn: string

        the ARN to split into its components

        +
      • arnFormat: ArnFormat

        the expected format of 'arn' - depends on what format the service 'arn' represents uses

        +

      Returns ArnComponents

    addTransform

    • addTransform(transform: string): void

      Add a Transform to this stack. A Transform is a macro that AWS +CloudFormation uses to process your template.

      +

      Duplicate values are removed when stack is synthesized.

      +

      Parameters

      • transform: string

        The transform to add

        +

      Returns void

      See

      https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

      +

      Example

      declare const stack: Stack;

      stack.addTransform('AWS::Serverless-2016-10-31')
+
      + +

    addMetadata

    _addAssemblyDependency

    • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
      Internal

      Called implicitly by the addDependency helper function in order to +realize a dependency between two top-level stacks at the assembly level.

      +

      Use stack.addDependency to define the dependency between any two stacks, +and take into account nested stack relationships.

      +

      Parameters

      • target: Stack
      • Optionalreason: StackDependencyReason

      Returns void

    _obtainAssemblyDependencies

    • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
      Internal

      Called implicitly by the obtainDependencies helper function in order to +collect resource dependencies across two top-level stacks at the assembly level.

      +

      Use stack.obtainDependencies to see the dependencies between any two stacks.

      +

      Parameters

      • reasonFilter: StackDependencyReason

      Returns Element[]

    _removeAssemblyDependency

    • _removeAssemblyDependency(
          target: Stack,
          reasonFilter?: StackDependencyReason,
      ): void
      Internal

      Called implicitly by the removeDependency helper function in order to +remove a dependency between two top-level stacks at the assembly level.

      +

      Use stack.addDependency to define the dependency between any two stacks, +and take into account nested stack relationships.

      +

      Parameters

      • target: Stack
      • OptionalreasonFilter: StackDependencyReason

      Returns void

    _synthesizeTemplate

    • _synthesizeTemplate(
          session: ISynthesisSession,
          lookupRoleArn?: string,
          lookupRoleExternalId?: string,
          lookupRoleAdditionalOptions?: { [key: string]: any },
      ): void
      Internal

      Synthesizes the cloudformation template into a cloud assembly.

      +

      Parameters

      • session: ISynthesisSession
      • OptionallookupRoleArn: string
      • OptionallookupRoleExternalId: string
      • OptionallookupRoleAdditionalOptions: { [key: string]: any }

      Returns void

    regionalFact

    • regionalFact(factName: string, defaultValue?: string): string

      Look up a fact value for the given fact for the region of this stack

      +

      Will return a definite value only if the region of the current stack is resolved. +If not, a lookup map will be added to the stack and the lookup will be done at +CDK deployment time.

      +

      What regions will be included in the lookup map is controlled by the +@aws-cdk/core:target-partitions context value: it must be set to a list +of partitions, and only regions from the given partitions will be included. +If no such context key is set, all regions will be included.

      +

      This function is intended to be used by construct library authors. Application +builders can rely on the abstractions offered by construct libraries and do +not have to worry about regional facts.

      +

      If defaultValue is not given, it is an error if the fact is unknown for +the given region.

      +

      Parameters

      • factName: string
      • OptionaldefaultValue: string

      Returns string

    exportValue

    • exportValue(exportedValue: any, options?: ExportValueOptions): string

      Create a CloudFormation Export for a string value

      +

      Returns a string representing the corresponding Fn.importValue() +expression for this Export. You can control the name for the export by +passing the name option.

      +

      If you don't supply a value for name, the value you're exporting must be +a Resource attribute (for example: bucket.bucketName) and it will be +given the same name as the automatic cross-stack reference that would be created +if you used the attribute in another Stack.

      +

      One of the uses for this method is to remove the relationship between +two Stacks established by automatic cross-stack references. It will +temporarily ensure that the CloudFormation Export still exists while you +remove the reference from the consuming stack. After that, you can remove +the resource and the manual export.

      +

      Here is how the process works. Let's say there are two stacks, +producerStack and consumerStack, and producerStack has a bucket +called bucket, which is referenced by consumerStack (perhaps because +an AWS Lambda Function writes into it, or something like that).

      +

      It is not safe to remove producerStack.bucket because as the bucket is being +deleted, consumerStack might still be using it.

      +

      Instead, the process takes two deployments:

      +

      Deployment 1: break the relationship:

      +
        +
      • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer +stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just +remove the Lambda Function altogether).
        • +
      • In the ProducerStack class, call this.exportValue(this.bucket.bucketName). This +will make sure the CloudFormation Export continues to exist while the relationship +between the two stacks is being broken.
        • +
      • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).
        • +
      +

      Deployment 2: remove the bucket resource:

      +
        +
      • You are now free to remove the bucket resource from producerStack.
        • +
      • Don't forget to remove the exportValue() call as well.
        • +
      • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
        • +
      +

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string

    exportStringListValue

    • exportStringListValue(
          exportedValue: any,
          options?: ExportValueOptions,
      ): string[]

      Create a CloudFormation Export for a string list value

      +

      Returns a string list representing the corresponding Fn.importValue() +expression for this Export. The export expression is automatically wrapped with an +Fn::Join and the import value with an Fn::Split, since CloudFormation can only +export strings. You can control the name for the export by passing the name option.

      +

      If you don't supply a value for name, the value you're exporting must be +a Resource attribute (for example: bucket.bucketName) and it will be +given the same name as the automatic cross-stack reference that would be created +if you used the attribute in another Stack.

      +

      One of the uses for this method is to remove the relationship between +two Stacks established by automatic cross-stack references. It will +temporarily ensure that the CloudFormation Export still exists while you +remove the reference from the consuming stack. After that, you can remove +the resource and the manual export.

      +

      See exportValue for an example of this process.

      +

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string[]

    ProtectedallocateLogicalId

    • allocateLogicalId(cfnElement: CfnElement): string

      Returns the naming scheme used to allocate logical IDs. By default, uses +the HashedAddressingScheme but this method can be overridden to customize +this behavior.

      +

      In order to make sure logical IDs are unique and stable, we hash the resource +construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as +a suffix to the path components joined without a separator (CloudFormation +IDs only allow alphanumeric characters).

      +

      The result will be:

      +

      <path.join('')><md5(path.join('/')> +"human" "hash"

      +

      If the "human" part of the ID exceeds 240 characters, we simply trim it so +the total ID doesn't exceed CloudFormation's 255 character limit.

      +

      We only take 8 characters from the md5 hash (0.000005 chance of collision).

      +

      Special cases:

      +
        +
      • If the path only contains a single component (i.e. it's a top-level +resource), we won't add the hash to it. The hash is not needed for +disambiguation and also, it allows for a more straightforward migration an +existing CloudFormation template to a CDK stack without logical ID changes +(or renames).
        • +
      • For aesthetic reasons, if the last components of the path are the same +(i.e. L1/L2/Pipeline/Pipeline), they will be de-duplicated to make the +resulting human portion of the ID more pleasing: L1L2Pipeline<HASH> +instead of L1L2PipelinePipeline<HASH>
        • +
      • If a component is named "Default" it will be omitted from the path. This +allows refactoring higher level abstractions around constructs without affecting +the IDs of already deployed resources.
        • +
      • If a component is named "Resource" it will be omitted from the user-visible +path, but included in the hash. This reduces visual noise in the human readable +part of the identifier.
        • +
      +

      Parameters

      • cfnElement: CfnElement

        The element for which the logical ID is allocated.

        +

      Returns string

    Protected_validateId

    • _validateId(name: string): void
      Internal

      Validate stack name

      +

      CloudFormation stack names can include dashes in addition to the regular identifier +character classes, and we don't allow one of the magic markers.

      +

      Parameters

      • name: string

      Returns void

    Protected_toCloudFormation

    • _toCloudFormation(): any
      Internal

      Returns the CloudFormation template for this stack by traversing +the tree and invoking _toCloudFormation() on all Entity objects.

      +

      Returns any

    StaticisConstruct

    • isConstruct(x: any): x is Construct

      Checks if x is a construct.

      +

      Use this method instead of instanceof to properly detect Construct +instances, even when the construct library is symlinked.

      +

      Explanation: in JavaScript, multiple copies of the constructs library on +disk are seen as independent, completely different libraries. As a +consequence, the class Construct in each copy of the constructs library +is seen as a different class, and an instance of one class will not test as +instanceof the other class. npm install will not create installations +like this, but users may manually symlink construct libraries together or +use a monorepo tool: in those cases, multiple copies of the constructs +library can be accidentally installed, and instanceof will behave +unpredictably. It is safest to avoid using instanceof, and using +this type-testing method instead.

      +

      Parameters

      • x: any

        Any object

        +

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

      +

    toString

    • toString(): string

      Returns a string representation of this construct.

      +

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html deleted file mode 100644 index 1544352..0000000 --- a/classes/SourceRepo.html +++ /dev/null @@ -1,27 +0,0 @@ -SourceRepo | aws4embeddedlinux-cdk-lib

    Class SourceRepo

    The repository for the Source Stage of the pipeline.

    -

    The initial contents of this repository are seeded by the assets contained -in the source-repo/ folder of this library.

    -

    Hierarchy

    • Construct
      • SourceRepo

    Constructors

    constructor -

    Properties

    repo -node -

    Methods

    isConstruct -toString -

    Constructors

    constructor

    Properties

    Readonlyrepo

    repo: Repository

    The CodeCommit Repo itself.

    -

    Readonlynode

    node: Node

    The tree node.

    -

    Methods

    StaticisConstruct

    • isConstruct(x: any): x is Construct

    • Checks if x is a construct.

      -

      Use this method instead of instanceof to properly detect Construct -instances, even when the construct library is symlinked.

      -

      Explanation: in JavaScript, multiple copies of the constructs library on -disk are seen as independent, completely different libraries. As a -consequence, the class Construct in each copy of the constructs library -is seen as a different class, and an instance of one class will not test as -instanceof the other class. npm install will not create installations -like this, but users may manually symlink construct libraries together or -use a monorepo tool: in those cases, multiple copies of the constructs -library can be accidentally installed, and instanceof will behave -unpredictably. It is safest to avoid using instanceof, and using -this type-testing method instead.

      -

      Parameters

      • x: any

        Any object

        -

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

      -

    toString

    • toString(): string

    • Returns a string representation of this construct.

      -

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/enums/ImageKind.html b/enums/ImageKind.html deleted file mode 100644 index 36114c4..0000000 --- a/enums/ImageKind.html +++ /dev/null @@ -1,4 +0,0 @@ -ImageKind | aws4embeddedlinux-cdk-lib

    Enumeration ImageKind

    The type of Image to build on.

    -

    Enumeration Members

    Ubuntu22_04 -

    Enumeration Members

    Ubuntu22_04

    Ubuntu22_04: "ubuntu_22_04"

    Ubuntu 22.04 (LTS)

    -

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html deleted file mode 100644 index 1f888cd..0000000 --- a/enums/ProjectKind.html +++ /dev/null @@ -1,16 +0,0 @@ -ProjectKind | aws4embeddedlinux-cdk-lib

    Enumeration ProjectKind

    The kind of project built.

    -

    Enumeration Members

    Poky -MetaAwsDemo -PokyAmi -Kas -Renesas -NxpImx -CodeBuild -

    Enumeration Members

    Poky

    Poky: "poky"

    Build core-image-minimal from poky.

    -

    MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"

    Build the Qemu meta-aws Demonstration Distribution.

    -

    PokyAmi

    PokyAmi: "poky-ami"

    Build an EC2 AMI

    -

    Kas

    Kas: "kas"

    Build an kas based image

    -

    Renesas

    Renesas: "renesas"

    Build an Renesas image

    -

    NxpImx

    NxpImx: "nxp-imx"

    Build an IMX image using NXP layers.

    -

    CodeBuild

    CodeBuild: "codebuild"

    Build no pipeline, just CodeBuild project to connect with GitHub actions.

    -

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/ProjectType.html b/enums/ProjectType.html new file mode 100644 index 0000000..4867a24 --- /dev/null +++ b/enums/ProjectType.html @@ -0,0 +1,18 @@ +ProjectType | aws4embeddedlinux-cdk-lib

    Enumeration ProjectType

    The type of project built.

    +

    Enumeration Members

    Poky +QEmu +PokyAmi +Kas +Renesas +NxpImx +CodeBuild +Custom +

    Enumeration Members

    Poky

    Poky: "poky"

    Build core-image-minimal from poky.

    +

    QEmu

    QEmu: "qemu"

    Build the Qemu meta-aws Demonstration Distribution.

    +

    PokyAmi

    PokyAmi: "poky-ami"

    Build an EC2 AMI

    +

    Kas

    Kas: "kas"

    Build an kas based image

    +

    Renesas

    Renesas: "renesas"

    Build an Renesas image

    +

    NxpImx

    NxpImx: "nxp-imx"

    Build an IMX image using NXP layers.

    +

    CodeBuild

    CodeBuild: "codebuild"

    Build no pipeline, just CodeBuild project to connect with GitHub actions.

    +

    Custom

    Custom: "custom"

    Build an image using a custom buildspec and asstes.

    +

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/functions/isBucketVersioned.html b/functions/isBucketVersioned.html new file mode 100644 index 0000000..6438a58 --- /dev/null +++ b/functions/isBucketVersioned.html @@ -0,0 +1 @@ +isBucketVersioned | aws4embeddedlinux-cdk-lib

    Function isBucketVersioned

    • isBucketVersioned(bucket: IBucket | Bucket): boolean

      Parameters

      • bucket: IBucket | Bucket

      Returns boolean

    Settings

    Member Visibility
    diff --git a/index.html b/index.html index 96fd5d7..76d2e60 100644 --- a/index.html +++ b/index.html @@ -1,64 +1,233 @@ -aws4embeddedlinux-cdk-lib

    aws4embeddedlinux-cdk-lib

    aws4embeddedlinux-ci

    This cdk IaC library helps you to deploy AWS cloud infrastructure to allow embedded Linux builds for your project.

    -

    Architecture

    architecture overview

    -

    API documentation

    API documentation generated by npm run doc

    -

    Setting Up

    In order to use this library, you must set up the CDK, including -installing the CDK tool and bootstrapping the account you wish to deploy to. Additionally, you must have Node installed.

    -
    Note

    -This library is tested against Node Versions 22. If these version is not available for your system, we recommend -using NVM to install a compatible version

    -
    -

    Quickstart

    Use the examples in our examples repo.

    -

    Setting Up A New Project

      -
    1. Create a CDK project. More details can be found in the CDK Getting Started Documentation.
      mkdir my-project
      cd my-project
      cdk init app --language typescript
+aws4embeddedlinux-cdk-lib
      aws4embeddedlinux-cdk-lib
      aws4embeddedlinux-ci
      The aws4embeddedlinux-ci library helps you deploy an AWS cloud infrastructure supporting the Embedded Linux builds for your project using AWS CDK.
      
+
      Table of Contents
        
+
      1. Architecture
        2. 
+
      2. API documentation
        3. 
+
      3. Project Build with AWS CodePipeline
        4. 
+
      4. Project Build with AWS CodeBuild as Action Runner
        5. 
+
      5. Setup
        6. 
+
      6. Development Setup
        7. 
+
      7. Known issues
        8. 
+
      8. Security
        9. 
+
      9. Contributing
        10. 
+
      10. License
        11. 
+
      
+
      Architecture
      This is the overall architecture pattern used to deploy the build pipeline:
      
+
      architecture overview
      
+
      Bask to the top
      
+
      API documentation
      The API documentation is generated automatically using Typedoc.
      
+
      Bask to the top
      
+
      Project Build with AWS CodePipeline
      Several pipelines are provided in this library, each one demonstrating a different aspect of how to build a Yocto image with AWS.
      
+
      Once deployed, ou can review the pipeline execution from the Developer Tools > Pipeline - CodePipeline > Pipelines page in the AWS Console.
      
+
      From the pipeline page, you can find the source repository (S3), the CodeBuild Project (with the build logs), and the S3 bucket that the image is uploaded to, at the end.
      
+
      Each pipelines will refresh/re-run automatically every week using AWS EventBridge in order to grab the latest updates.
      
+
      Poky
      The pipeline name will end with poky.
      
+
      This example will build the core-image-minimal image from Poky using the repo tool to manage layers. CVE checking is also enabled in the buildspec file.
      
+
      Expected build times:
      
+
        
+
      • First build: 32 minutes
        • 
+
      • Rebuild (without any change, just use sstate cache): 8 minutes
        • 
+
      
+
      Poky EC2 AMI
      The pipeline name will end with poky-ami.
      
+
      Yocto can be used to create an EC2 AMI. This example builds an AMI based on Poky and meta-aws and exports it to your AMI registry using the VM Import/Export Service.
      
+
      Expected build times:
      
+
        
+
      • First build: 52 minutes
        • 
+
      • Rebuild (without any change, just use sstate cache): 17 minutes
        • 
+
      
+
      Kas
      The pipeline name will end with kas.
      
+
      The Kas example shows how to use a Kas Config to manage layers.
      
+
      This tool can help programatically manage layers and config with tighter Yocto integration than Git Submodules or the Repo tool.
      
+
      Expected build times:
      
+
        
+
      • First build: 36 minutes
        • 
+
      • Rebuild (without any change, just use sstate cache): 11 minutes
        • 
+
      
+
      QEmu
      The pipeline name will end with qemu.
      
+
      This example builds a Qemu based image using meta-aws-demos.
      
+
      The Qemu image can be run in the CodeBuild environment. Using SLIRP networking, OEQA testing such as ptest can be run in the pipeline.
      
+
      Expected build times:
      
+
        
+
      • First build: 45 minutes
        • 
+
      • Rebuild (without any change, just use sstate cache): 14 minutes
        • 
+
      
+
      NXP / IMX
      The pipeline name will end with nxp.
      
+
      This example will build an image for the i.MX 6ULL EVK board.
      
+
      NXP requires users to accept and comply with a EULA in order to build and, for this reason, the buildspec will require modification before the build succeeds.
      
+
      See the IMX Yocto Users Guide for more detail.
      
+
      Expected build times:
      
+
        
+
      • First build: xx minutes
        • 
+
      • Rebuild (without any change, just use sstate cache): xx minutes
        • 
+
      
+
      Renesas
      This example is based on the Yocto / Renesas R-Car work to build an image for Renesas R-Car-H3 Starter Kit Premier board (unofficial name - H3ULCB) including the proprietary graphics and multimedia drivers from Renesas.
      
+
      You will need to download the Multimedia and Graphics library and related Linux drivers from the following link (registration necessary):
      
+
+
      Download the following files:
      
+
        
+
      • R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-20220121
        • 
+
      • R-Car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-20220121
        • 
+
      
+
      Graphic drivers are required for Wayland. Multimedia drivers are optional.
      
+
      Steps to build the image:
      
+
        
+
      • Create a folder named proprietary in the root of the source repo
        • 
+
      • Copy the downloaded files into the proprietary folder
        • 
+
      • Uncomment the #TODO line in the build.sh file in the source repo
        • 
+
      • Deploy the build pipeline
        • 
+
      
+
      A build should automatically start. Once it succeeds you will get an image containing the proprietary graphics and multimedia drivers.
      
+
      Expected build times:
      
+
        
+
      • First build: 30 minutes
        • 
+
      • Rebuild (without any change, just use sstate cache): 9 minutes
        • 
+
      
+
      Bask to the top
      
+
      Project Build with AWS CodeBuild as Action Runner
      This will create an AWS CodeBuild project ready to build Embedded Linux which can be used to connect to an external source, e.g. GitHub Actions. This is not using any AWS CodePipeline as in the the Pipeline examples section.
      
+
      You can use the following example for your GitHub Action.
      
+
      We recommend you to clone the created AWS CodeBuild project and then proceed with the GitHub Action configuration.
+However, this will result in the use of the same EFS file system across projects.
      
+
      Using the AWS CodeBuild project requires a source to be configured manually in the AWS Console at Developer Tools > Build - CodeBuild > Projects.
      
+
      To configure the AWS CodeBuild source connection to a GitHub repository, you will need to:
      
+
        
+
      • Select the AWS CodeBuild project (aws4el-ci-codebuild-project)
        • 
+
      • Select the Project Details tab
        • 
+
      • Scroll to the Source section and click on Edit.
        • 
+
      • Select GitHub as a Source provider. Configure the access to your repository
        • 
+
      • Scroll to the Primary source webhook events section, enable Rebuild every time a code change is pushed to this repository
        • 
+
      • Expand the Webhook event filter groups section and click on Add filter group if no group is present, then select WORKFLOW_JOB_QUEUED as Filter group 1
        • 
+
      
+
      Modify your repository GitHub action by replacing the following line:
      
+
      runs-on: ${{ vars.CODEBUILD_RUNNER_NAME }}-${{ github.run_id }}-${{ github.run_attempt }}
 
      
 
-
      2. -
    2. Add the cdk library with npm install aws4embeddedlinux/aws4embeddedlinux-ci.
      3. -
    3. Create your application using the library. Refer to the API Documentation -and the Examples for more details.
      4. -
    4. Deploy your application using cdk deploy.
      5. -
    5. After the application is deployed, the 'Build Image' Pipeline needs to be run. This will create an Ubuntu based container for -building Yocto. This container is used by the other pipelines. If the other pipelines are run before this container is created -and pushed to ECR, they will fail. This Build Image Pipeline will run weekly by default to keep -this container patched.
      6. -
    6. Now the application pipeline can be run. This will push the contents of the Yocto deploy directory into S3.
      7. -
    -

    Viewing Changes

    The cdk diff command can be used to preview changes before deployment. This will allow the user to review what is being created.

    -

    Development Setup

    You can use npm link to develop with a local copy of this repo.

    -

    In this library repo:

    npm install
+
    with:
    
+
    runs-on: codebuild-<project-name>-${{ github.run_id }}-${{ github.run_attempt }}
+
    
+
+
    <project-name> should be replaced by your AWS CodeBuild project name (aws4el-ci-codebuild-project).
+There might be more than one occuerence to replace in the file.
    
+
    Refer to the following example for more details.
    
+
    Bask to the top
    
+
    Setup
    In order to use this library, you must first set up an AWS CDK project, including
+installing the CDK tool and bootstrapping the account you wish to deploy to.
    
+
    Additionally, you must have NodeJS installed.
    
+
    Note
    
+
    This library is tested against Node Versions 22. If these version is not available for your system, we recommend using NVM to install a compatible version.
    
+
    
+
    You can also use the sample project code provided to get started and deploy the stacks.
    
+
    Bask to the top
    
+
    Setting Up A New Project
    In order to create a new project, you will need to initialize a new CDK project.
    
+
    More details can be found in the CDK Getting Started Documentation.
    
+
    The following commands will create a new CDK project named my-project:
    
+
    mkdir my-project
    cd my-project
    cdk init app --language typescript
 
    
 
-
    In your-project folder:
    npm install
    npm link ../aws4embeddedlinux-ci
+
    Then you will need to install the CDK library including the aws4embeddedlinux-ci library either using npm:
    
+
    npm install aws4embeddedlinux/aws4embeddedlinux-ci
 
    
 
-
    This will link through the system node_modules install. When using a system node install on Linux, this can require sudo access. To avoid this, use
-a node version manager
-or set a node prefix.
    
-
    Known issues
      
-
    • Windows is currently not supported.
      • 
-
    • When using AWS Cloud9 a micro instance type will run out of memory.
      • 
-
    • Deletion of stacks while a CodePipeline is running can lead to unexpected failures.
      • 
-
    
-
    Security
    See SECURITY for more information about reporting issues with this project.
    
-
    Git Credentials and Build Time Secrets
    AWS Secrets Manager is the preferred method of adding secrets
-to your pipeline. This service provides a structured means of access and avoids the pitfalls of putting secrets in environment variables,
-source repos, etc.
    
-
      
-
    1. Create a Secret in Secrets Manager and add your secret value.
      2. 
-
    2. Grant access permissions to the CodeBuild pipeline project.
      3. 
-
    3. Create a Policy Statement which allows secretsmanager:GetSecretValue for your secret.
      4. 
-
    4. Add this policy statement to the buildPolicyAdditions props for the EmbeddedLinuxPipelineStack. e.g.
      5. 
-
    
-
    import * as iam from "aws-cdk-lib/aws-iam";

    const pipeline = new EmbeddedLinuxPipelineStack(app, "MyPokyPipeline", {
      imageRepo: buildImageRepo.repository,
      imageTag: ImageKind.Ubuntu22_04,
      vpc: vpc.vpc,
      buildPolicyAdditions: [
        iam.PolicyStatement.fromJson({
          Effect: "Allow",
          Action: "secretsmanager:GetSecretValue",
          Resource:
            "arn:aws:secretsmanager:us-west-2:123456789012:secret:my-secret-??????",
        }),
      ],
    });
+
    of `yarn':
    
+
    yarn add github:aws4embeddedlinux/aws4embeddedlinux-ci
    yarn install
+
    
+
+
    
+
    If you are not familliar with Yarn, please refer to the documentation.
    
+
    
+
    Once added, you can start creatin your application using the library.
    
+
    For example, you can start by importing classes using:
    
+
    import {
      EmbeddedLinuxCodePipelineBaseImageStack,
      EmbeddedLinuxCodePipelineStack,
      EmbeddedLinuxCodeBuildProjectStack,
      PipelineResourcesStack,
      ProjectType,
    } from "aws4embeddedlinux-cdk-lib";
 
    
 
-
    The secret can then be used in the CodeBuild Project by adding it to the BuildSpec. See
-the CodeBuild Documentation for more details.
    
-
    env:
        secrets-manager:
            SECRET_VALUE: "<Secret ARN>"
+
    Then deploy the base resources and base image pipeline stacks:
    
+
    const pipelineResourcesStack = new PipelineResourcesStack(app, `demo-resources`, {...});
    const baseImageStack = new EmbeddedLinuxCodePipelineBaseImageStack(app, `demo-pipeline-base-image`, {...});
 
    
 
-
    CVE Checking With Yocto
    CVE checking is enabled in the reference implementations. Details on this can be found in
-the yocto documentation.
    
-
    Contributing
    See CONTRIBUTING for more information.
    
-
    License
    This library is licensed under the MIT-0 License. See the LICENSE file.
    
-

    Settings

    Member Visibility

    On This Page

    aws4embeddedlinux-ciSetting Up
    +

    And ultimately deploy the target pipeline:

    +
    const projectPipeline = new EmbeddedLinuxCodePipelineStack(app, "demo-project", {
      projectType: ProjectType.Poky,
      ecrRepository: <ecrRepository>,
      ecrRepositoryImageTag: <ecrRepositoryImageTag>,
      pipelineSourceBucket: <SourceBucket>,
      pipelineArtifactBucket: <ArtifactBucket>,
      pipelineOutputBucket: <OutputBucket>,
      vpc: <vpc>,
      encryptionKey: <encryptionKey>,
    });
+
    + +

    Refer to the API Documentation and the sample for more details.

    +

    Once you have completed the code of your application, you can deploy the CDK stack using:

    +
    cdk deploy
+
    + +

    After the CDK application is successfully deployed, the 'Base Image' pipeline needs to complete successfully.

    +

    This will create an Ubuntu based container for building the Yocto images.

    +
    Note

    +

    This container is used by the other pipelines. If the other pipelines are run before this container is created and pushed to ECR, they will fail.

    +

    The 'Base Image' pipeline will run weekly by default to keep the container patched and up to date.

    +
    +
    Note

    +

    We recommend you to deploy first the 'Base Image' pipeline and once the pipeline completes successfully, then you can deploy the other pipelines in you application as described in the sample.

    +
    +

    Once your pipelines completes successfully, the Yocto deploy directory generated content will be pushed into a S3 bucket.

    +

    Bask to the top

    +

    Development Setup

    The repository is leveraging Yarn 2 and if you are not familliar with Yarn, please refer to the documentation.

    +

    If you are looking to develop new feature, you can use yarn link to develop with a local copy of this repo.

    +

    In this library repo, execute the following:

    +
    yarn install
    yarn run build
    yarn link
+
    + +

    and in your project folder:

    +
    yarn install
    yarn link "aws4embeddedlinux-cdk-lib"
    yarn run build
+
    + +

    This will link through the system node_modules install.

    +
    +

    Note:

    +

    You should not install / reference the aws4embeddedlinux/aws4embeddedlinux-ci library in your package.json when using this approach.

    +
    +
    +

    Note:

    +

    After changing the code for the aws4embeddedlinux/aws4embeddedlinux-ci library, you will need to run yarn run build for changes to be available in your current project.

    +
    +
    +

    Note:

    +

    When using a system node install on Linux, this can require sudo access. +To avoid this, use a node version manager or set a node prefix.

    +
    +

    Using Git Credentials and Build Time Secrets

    AWS Secrets Manager is the preferred method for adding and using secrets in your pipelines.

    +

    The service provides a structured means of access and avoids the pitfalls of putting secrets in environment variables, source repos, etc.

    +

    The following steps detaisl at a high level, how you can enable the use of AWS Secrets Manager in your pipelines:

    +
      +
    • +

      Create a Secret in Secrets Manager and add your secret value.

      +
      • +
    • +

      Grant access permissions to the CodeBuild pipeline project.

      +
      • +
    • +

      Create a Policy Statement which allows secretsmanager:GetSecretValue for your secret.

      +
      • +
    • +

      Add this policy statement to the buildPolicyAdditions props for the EmbeddedLinuxPipelineStack. e.g.

      +
      import * as iam from "aws-cdk-lib/aws-iam";
      const projectPipeline = new EmbeddedLinuxCodePipelineStack(app, "MyPokyPipeline", {
        projectType: ProjectType.Poky,
        ecrRepository: <ecrRepository>,
        ecrRepositoryImageTag: <ecrRepositoryImageTag>,
        pipelineSourceBucket: <SourceBucket>,
        pipelineArtifactBucket: <ArtifactBucket>,
        pipelineOutputBucket: <OutputBucket>,
        vpc: <vpc>,
        encryptionKey: <encryptionKey>,
        buildPolicyAdditions: [
          iam.PolicyStatement.fromJson({
            Effect: "Allow",
            Action: "secretsmanager:GetSecretValue",
            Resource:
              "arn:aws:secretsmanager:us-west-2:123456789012:secret:my-secret-??????",
          }),
        ],
      });
+
      + +
      • +
    • +

      The secret can then be used in the CodeBuild Project by adding it to the BuildSpec.

      +
      env:
          secrets-manager:
              SECRET_VALUE: "<Secret ARN>"
+
      + +
      • +
    +

    See the CodeBuild Documentation for more details.

    +

    CVE Checking With Yocto

    CVE checking is enabled in the reference implementations. Details on this can be found in the Yocto documentation.

    +

    Bask to the top

    +

    Known issues

      +
    • The use of this CDK library is currently not supported in Windows environments (you can still use WSL).
      • +
    • When using AWS Cloud9, a micro instance type will run out of memory.
      • +
    • Deletion of stacks while a CodePipeline is running can lead to unexpected behaviours.
      • +
    • The NXP-IMX pipeline will fail unless you adjust the build spec file and address the licence acceptance requirement.
      • +
    +

    Bask to the top

    +

    Security

    See SECURITY for more information about reporting issues with this project.

    +

    Bask to the top

    +

    Contributing

    See CONTRIBUTING for more information.

    +

    Bask to the top

    +

    License

    This library is licensed under the MIT-0 License. See the LICENSE file.

    +

    Bask to the top

    +

    Settings

    Member Visibility

    On This Page

    aws4embeddedlinux-ci
    diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html deleted file mode 100644 index 6d20c52..0000000 --- a/interfaces/BuildImageDataProps.html +++ /dev/null @@ -1,94 +0,0 @@ -BuildImageDataProps | aws4embeddedlinux-cdk-lib

    Interface BuildImageDataProps

    Select options for the BuildImageDataStack.

    -
    interface BuildImageDataProps {
        bucketName: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • BuildImageDataProps

    Properties

    bucketName -description? -env? -stackName? -tags? -notificationArns? -synthesizer? -terminationProtection? -analyticsReporting? -crossRegionReferences? -permissionsBoundary? -suppressTemplateIndentation? -

    Properties

    ReadonlybucketName

    bucketName: string

    The bucket name for image build sources. This must be globally unique.

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    -

    Default

    - No description.
-
    - -

    Optional Readonlyenv

    env?: Environment

    The AWS environment (account/region) where this stack will be deployed.

    -

    Set the region/account fields of env to either a concrete value to -select the indicated environment (recommended for production stacks), or to -the values of environment variables -CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment -depend on the AWS credentials/configuration that the CDK CLI is executed -under (recommended for development stacks).

    -

    If the Stack is instantiated inside a Stage, any undefined -region/account fields from env will default to the same field on the -encompassing Stage, if configured there.

    -

    If either region or account are not set nor inherited from Stage, the -Stack will be considered "environment-agnostic"". Environment-agnostic -stacks can be deployed to any environment but may not be able to take -advantage of all features of the CDK. For example, they will not be able to -use environmental context lookups such as ec2.Vpc.fromLookup and will not -automatically translate Service Principals to the right format based on the -environment's AWS partition, and other such enhancements.

    -

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
-
    - -

    Default

      -
    • The environment of the containing Stage if available, -otherwise create the stack will be environment-agnostic.
      • -
    -

    Optional ReadonlystackName

    stackName?: string

    Name to deploy the stack with

    -

    Default

    - Derived from construct path.
-
    - -

    Optional Readonlytags

    tags?: { [key: string]: string }

    Stack tags that will be applied to all the taggable resources and the stack itself.

    -

    Default

    {}
-
    - -

    Optional ReadonlynotificationArns

    notificationArns?: string[]

    SNS Topic ARNs that will receive stack events.

    -

    Default

    - no notfication arns.
-
    - -

    Optional Readonlysynthesizer

    synthesizer?: IStackSynthesizer

    Synthesis method to use while deploying this stack

    -

    The Stack Synthesizer controls aspects of synthesis and deployment, -like how assets are referenced and what IAM roles to use. For more -information, see the README of the main CDK package.

    -

    If not specified, the defaultStackSynthesizer from App will be used. -If that is not specified, DefaultStackSynthesizer is used if -@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major -version is v2. In CDK v1 LegacyStackSynthesizer is the default if no -other synthesizer is specified.

    -

    Default

      -
    • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
      • -
    -

    Optional ReadonlyterminationProtection

    terminationProtection?: boolean

    Whether to enable termination protection for this stack.

    -

    Default

    false
-
    - -

    Optional ReadonlyanalyticsReporting

    analyticsReporting?: boolean

    Include runtime versioning information in this Stack

    -

    Default

    analyticsReporting setting of containing App, or value of -'aws:cdk:version-reporting' context key

    -

    Optional ReadonlycrossRegionReferences

    crossRegionReferences?: boolean

    Enable this flag to allow native cross region stack references.

    -

    Enabling this will create a CloudFormation custom resource -in both the producing stack and consuming stack in order to perform the export/import

    -

    This feature is currently experimental

    -

    Default

    false
-
    - -

    Optional ReadonlypermissionsBoundary

    permissionsBoundary?: PermissionsBoundary

    Options for applying a permissions boundary to all IAM Roles -and Users created within this Stage

    -

    Default

    - no permissions boundary is applied
-
    - -

    Optional ReadonlysuppressTemplateIndentation

    suppressTemplateIndentation?: boolean

    Enable this flag to suppress indentation in generated -CloudFormation templates.

    -

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation -context key will be used. If that is not specified, then the -default value false will be used.

    -

    Default

      -
    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
      • -
    -

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/BuildImagePipelineProps.html b/interfaces/BuildImagePipelineProps.html deleted file mode 100644 index d679b54..0000000 --- a/interfaces/BuildImagePipelineProps.html +++ /dev/null @@ -1,104 +0,0 @@ -BuildImagePipelineProps | aws4embeddedlinux-cdk-lib

    Interface BuildImagePipelineProps

    Select options for the BuildImagePipelineStack.

    -
    interface BuildImagePipelineProps {
        imageKind: Ubuntu22_04;
        dataBucket: IBucket;
        repository: IRepository;
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • BuildImagePipelineProps

    Properties

    imageKind -dataBucket -repository -accessLoggingBucket? -serverAccessLogsPrefix? -artifactBucket? -description? -env? -stackName? -tags? -notificationArns? -synthesizer? -terminationProtection? -analyticsReporting? -crossRegionReferences? -permissionsBoundary? -suppressTemplateIndentation? -

    Properties

    ReadonlyimageKind

    imageKind: Ubuntu22_04

    The Image type to create.

    -

    ReadonlydataBucket

    dataBucket: IBucket

    The data bucket from the BuildImageDataStack

    -

    Readonlyrepository

    repository: IRepository

    The ECR Repository to push to.

    -

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    -

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    -

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    -

    Default

    - No description.
-
    - -

    Optional Readonlyenv

    env?: Environment

    The AWS environment (account/region) where this stack will be deployed.

    -

    Set the region/account fields of env to either a concrete value to -select the indicated environment (recommended for production stacks), or to -the values of environment variables -CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment -depend on the AWS credentials/configuration that the CDK CLI is executed -under (recommended for development stacks).

    -

    If the Stack is instantiated inside a Stage, any undefined -region/account fields from env will default to the same field on the -encompassing Stage, if configured there.

    -

    If either region or account are not set nor inherited from Stage, the -Stack will be considered "environment-agnostic"". Environment-agnostic -stacks can be deployed to any environment but may not be able to take -advantage of all features of the CDK. For example, they will not be able to -use environmental context lookups such as ec2.Vpc.fromLookup and will not -automatically translate Service Principals to the right format based on the -environment's AWS partition, and other such enhancements.

    -

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
-
    - -

    Default

      -
    • The environment of the containing Stage if available, -otherwise create the stack will be environment-agnostic.
      • -
    -

    Optional ReadonlystackName

    stackName?: string

    Name to deploy the stack with

    -

    Default

    - Derived from construct path.
-
    - -

    Optional Readonlytags

    tags?: { [key: string]: string }

    Stack tags that will be applied to all the taggable resources and the stack itself.

    -

    Default

    {}
-
    - -

    Optional ReadonlynotificationArns

    notificationArns?: string[]

    SNS Topic ARNs that will receive stack events.

    -

    Default

    - no notfication arns.
-
    - -

    Optional Readonlysynthesizer

    synthesizer?: IStackSynthesizer

    Synthesis method to use while deploying this stack

    -

    The Stack Synthesizer controls aspects of synthesis and deployment, -like how assets are referenced and what IAM roles to use. For more -information, see the README of the main CDK package.

    -

    If not specified, the defaultStackSynthesizer from App will be used. -If that is not specified, DefaultStackSynthesizer is used if -@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major -version is v2. In CDK v1 LegacyStackSynthesizer is the default if no -other synthesizer is specified.

    -

    Default

      -
    • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
      • -
    -

    Optional ReadonlyterminationProtection

    terminationProtection?: boolean

    Whether to enable termination protection for this stack.

    -

    Default

    false
-
    - -

    Optional ReadonlyanalyticsReporting

    analyticsReporting?: boolean

    Include runtime versioning information in this Stack

    -

    Default

    analyticsReporting setting of containing App, or value of -'aws:cdk:version-reporting' context key

    -

    Optional ReadonlycrossRegionReferences

    crossRegionReferences?: boolean

    Enable this flag to allow native cross region stack references.

    -

    Enabling this will create a CloudFormation custom resource -in both the producing stack and consuming stack in order to perform the export/import

    -

    This feature is currently experimental

    -

    Default

    false
-
    - -

    Optional ReadonlypermissionsBoundary

    permissionsBoundary?: PermissionsBoundary

    Options for applying a permissions boundary to all IAM Roles -and Users created within this Stage

    -

    Default

    - no permissions boundary is applied
-
    - -

    Optional ReadonlysuppressTemplateIndentation

    suppressTemplateIndentation?: boolean

    Enable this flag to suppress indentation in generated -CloudFormation templates.

    -

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation -context key will be used. If that is not specified, then the -default value false will be used.

    -

    Default

      -
    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
      • -
    -

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/EmbeddedLinuxCodeBuildProjectProps.html b/interfaces/EmbeddedLinuxCodeBuildProjectProps.html new file mode 100644 index 0000000..7654f10 --- /dev/null +++ b/interfaces/EmbeddedLinuxCodeBuildProjectProps.html @@ -0,0 +1,102 @@ +EmbeddedLinuxCodeBuildProjectProps | aws4embeddedlinux-cdk-lib

    Interface EmbeddedLinuxCodeBuildProjectProps

    Properties to allow customizing the build.

    +
    interface EmbeddedLinuxCodeBuildProjectProps {
        ecrRepository: IRepository;
        ecrRepositoryImageTag: string;
        vpc: IVpc;
        buildPolicyAdditions?: PolicyStatement[];
        encryptionKey: Key;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxCodeBuildProjectProps

    Properties

    ecrRepository +ecrRepositoryImageTag +vpc +buildPolicyAdditions? +encryptionKey +description? +env? +stackName? +tags? +notificationArns? +synthesizer? +terminationProtection? +analyticsReporting? +crossRegionReferences? +permissionsBoundary? +suppressTemplateIndentation? +

    Properties

    ReadonlyecrRepository

    ecrRepository: IRepository

    ECR Repository where the Build Host Image resides.

    +

    ReadonlyecrRepositoryImageTag

    ecrRepositoryImageTag: string

    Tag for the Build Host Image

    +

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    +

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    +

    ReadonlyencryptionKey

    encryptionKey: Key

    The encryption key use across

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Default

    - No description.
+
    + +

    Optional Readonlyenv

    env?: Environment

    The AWS environment (account/region) where this stack will be deployed.

    +

    Set the region/account fields of env to either a concrete value to +select the indicated environment (recommended for production stacks), or to +the values of environment variables +CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment +depend on the AWS credentials/configuration that the CDK CLI is executed +under (recommended for development stacks).

    +

    If the Stack is instantiated inside a Stage, any undefined +region/account fields from env will default to the same field on the +encompassing Stage, if configured there.

    +

    If either region or account are not set nor inherited from Stage, the +Stack will be considered "environment-agnostic"". Environment-agnostic +stacks can be deployed to any environment but may not be able to take +advantage of all features of the CDK. For example, they will not be able to +use environmental context lookups such as ec2.Vpc.fromLookup and will not +automatically translate Service Principals to the right format based on the +environment's AWS partition, and other such enhancements.

    +

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
+
    + +

    Default

      +
    • The environment of the containing Stage if available, +otherwise create the stack will be environment-agnostic.
      • +
    +

    Optional ReadonlystackName

    stackName?: string

    Name to deploy the stack with

    +

    Default

    - Derived from construct path.
+
    + +

    Optional Readonlytags

    tags?: { [key: string]: string }

    Stack tags that will be applied to all the taggable resources and the stack itself.

    +

    Default

    {}
+
    + +

    Optional ReadonlynotificationArns

    notificationArns?: string[]

    SNS Topic ARNs that will receive stack events.

    +

    Default

    - no notfication arns.
+
    + +

    Optional Readonlysynthesizer

    synthesizer?: IStackSynthesizer

    Synthesis method to use while deploying this stack

    +

    The Stack Synthesizer controls aspects of synthesis and deployment, +like how assets are referenced and what IAM roles to use. For more +information, see the README of the main CDK package.

    +

    If not specified, the defaultStackSynthesizer from App will be used. +If that is not specified, DefaultStackSynthesizer is used if +@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major +version is v2. In CDK v1 LegacyStackSynthesizer is the default if no +other synthesizer is specified.

    +

    Default

      +
    • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
      • +
    +

    Optional ReadonlyterminationProtection

    terminationProtection?: boolean

    Whether to enable termination protection for this stack.

    +

    Default

    false
+
    + +

    Optional ReadonlyanalyticsReporting

    analyticsReporting?: boolean

    Include runtime versioning information in this Stack

    +

    Default

    analyticsReporting setting of containing App, or value of +'aws:cdk:version-reporting' context key

    +

    Optional ReadonlycrossRegionReferences

    crossRegionReferences?: boolean

    Enable this flag to allow native cross region stack references.

    +

    Enabling this will create a CloudFormation custom resource +in both the producing stack and consuming stack in order to perform the export/import

    +

    This feature is currently experimental

    +

    Default

    false
+
    + +

    Optional ReadonlypermissionsBoundary

    permissionsBoundary?: PermissionsBoundary

    Options for applying a permissions boundary to all IAM Roles +and Users created within this Stage

    +

    Default

    - no permissions boundary is applied
+
    + +

    Optional ReadonlysuppressTemplateIndentation

    suppressTemplateIndentation?: boolean

    Enable this flag to suppress indentation in generated +CloudFormation templates.

    +

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation +context key will be used. If that is not specified, then the +default value false will be used.

    +

    Default

      +
    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
      • +
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html new file mode 100644 index 0000000..13f94e7 --- /dev/null +++ b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html @@ -0,0 +1,102 @@ +EmbeddedLinuxCodePipelineBaseImageProps | aws4embeddedlinux-cdk-lib

    Interface EmbeddedLinuxCodePipelineBaseImageProps

    Select options for the BuildImageCodePipelineStack.

    +
    interface EmbeddedLinuxCodePipelineBaseImageProps {
        pipelineSourceBucket: IBucket;
        pipelineSourcePrefix?: string;
        pipelineArtifactBucket: Bucket;
        ecrRepository: IRepository;
        encryptionKey: Key;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxCodePipelineBaseImageProps

    Properties

    pipelineSourceBucket +pipelineSourcePrefix? +pipelineArtifactBucket +ecrRepository +encryptionKey +description? +env? +stackName? +tags? +notificationArns? +synthesizer? +terminationProtection? +analyticsReporting? +crossRegionReferences? +permissionsBoundary? +suppressTemplateIndentation? +

    Properties

    ReadonlypipelineSourceBucket

    pipelineSourceBucket: IBucket

    The pipeline source bucket

    +

    OptionalpipelineSourcePrefix

    pipelineSourcePrefix?: string

    The pipeline source prefix

    +

    ReadonlypipelineArtifactBucket

    pipelineArtifactBucket: Bucket

    Artifact bucket to use

    +

    ReadonlyecrRepository

    ecrRepository: IRepository

    The ECR Repository to push to.

    +

    ReadonlyencryptionKey

    encryptionKey: Key

    The encryption key use across

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Default

    - No description.
+
    + +

    Optional Readonlyenv

    env?: Environment

    The AWS environment (account/region) where this stack will be deployed.

    +

    Set the region/account fields of env to either a concrete value to +select the indicated environment (recommended for production stacks), or to +the values of environment variables +CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment +depend on the AWS credentials/configuration that the CDK CLI is executed +under (recommended for development stacks).

    +

    If the Stack is instantiated inside a Stage, any undefined +region/account fields from env will default to the same field on the +encompassing Stage, if configured there.

    +

    If either region or account are not set nor inherited from Stage, the +Stack will be considered "environment-agnostic"". Environment-agnostic +stacks can be deployed to any environment but may not be able to take +advantage of all features of the CDK. For example, they will not be able to +use environmental context lookups such as ec2.Vpc.fromLookup and will not +automatically translate Service Principals to the right format based on the +environment's AWS partition, and other such enhancements.

    +

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
+
    + +

    Default

      +
    • The environment of the containing Stage if available, +otherwise create the stack will be environment-agnostic.
      • +
    +

    Optional ReadonlystackName

    stackName?: string

    Name to deploy the stack with

    +

    Default

    - Derived from construct path.
+
    + +

    Optional Readonlytags

    tags?: { [key: string]: string }

    Stack tags that will be applied to all the taggable resources and the stack itself.

    +

    Default

    {}
+
    + +

    Optional ReadonlynotificationArns

    notificationArns?: string[]

    SNS Topic ARNs that will receive stack events.

    +

    Default

    - no notfication arns.
+
    + +

    Optional Readonlysynthesizer

    synthesizer?: IStackSynthesizer

    Synthesis method to use while deploying this stack

    +

    The Stack Synthesizer controls aspects of synthesis and deployment, +like how assets are referenced and what IAM roles to use. For more +information, see the README of the main CDK package.

    +

    If not specified, the defaultStackSynthesizer from App will be used. +If that is not specified, DefaultStackSynthesizer is used if +@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major +version is v2. In CDK v1 LegacyStackSynthesizer is the default if no +other synthesizer is specified.

    +

    Default

      +
    • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
      • +
    +

    Optional ReadonlyterminationProtection

    terminationProtection?: boolean

    Whether to enable termination protection for this stack.

    +

    Default

    false
+
    + +

    Optional ReadonlyanalyticsReporting

    analyticsReporting?: boolean

    Include runtime versioning information in this Stack

    +

    Default

    analyticsReporting setting of containing App, or value of +'aws:cdk:version-reporting' context key

    +

    Optional ReadonlycrossRegionReferences

    crossRegionReferences?: boolean

    Enable this flag to allow native cross region stack references.

    +

    Enabling this will create a CloudFormation custom resource +in both the producing stack and consuming stack in order to perform the export/import

    +

    This feature is currently experimental

    +

    Default

    false
+
    + +

    Optional ReadonlypermissionsBoundary

    permissionsBoundary?: PermissionsBoundary

    Options for applying a permissions boundary to all IAM Roles +and Users created within this Stage

    +

    Default

    - no permissions boundary is applied
+
    + +

    Optional ReadonlysuppressTemplateIndentation

    suppressTemplateIndentation?: boolean

    Enable this flag to suppress indentation in generated +CloudFormation templates.

    +

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation +context key will be used. If that is not specified, then the +default value false will be used.

    +

    Default

      +
    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
      • +
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html new file mode 100644 index 0000000..b712828 --- /dev/null +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -0,0 +1,120 @@ +EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib

    Interface EmbeddedLinuxCodePipelineProps

    Properties to allow customizing the build.

    +
    interface EmbeddedLinuxCodePipelineProps {
        pipelineSourceBucket: IBucket;
        pipelineSourcePrefix?: string;
        pipelineArtifactBucket: Bucket;
        pipelineArtifactPrefix?: string;
        pipelineOutputBucket: Bucket;
        pipelineOutputPrefix?: string;
        ecrRepository: IRepository;
        ecrRepositoryImageTag: string;
        projectType: ProjectType;
        vpc: IVpc;
        buildPolicyAdditions?: PolicyStatement[];
        environmentVariables?: { string: BuildEnvironmentVariable };
        encryptionKey: Key;
        sourceCustomPath?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxCodePipelineProps

    Properties

    pipelineSourceBucket +pipelineSourcePrefix? +pipelineArtifactBucket +pipelineArtifactPrefix? +pipelineOutputBucket +pipelineOutputPrefix? +ecrRepository +ecrRepositoryImageTag +projectType +vpc +buildPolicyAdditions? +environmentVariables? +encryptionKey +sourceCustomPath? +description? +env? +stackName? +tags? +notificationArns? +synthesizer? +terminationProtection? +analyticsReporting? +crossRegionReferences? +permissionsBoundary? +suppressTemplateIndentation? +

    Properties

    ReadonlypipelineSourceBucket

    pipelineSourceBucket: IBucket

    The pipeline source bucket

    +

    OptionalpipelineSourcePrefix

    pipelineSourcePrefix?: string

    The pipeline source prefix

    +

    ReadonlypipelineArtifactBucket

    pipelineArtifactBucket: Bucket

    The pipeline artifact bucket to use

    +

    OptionalpipelineArtifactPrefix

    pipelineArtifactPrefix?: string

    The pipeline artifact bucket prefix to use

    +

    ReadonlypipelineOutputBucket

    pipelineOutputBucket: Bucket

    The pipeline output bucket to use

    +

    OptionalpipelineOutputPrefix

    pipelineOutputPrefix?: string

    The pipeline output bucket prefix to use

    +

    ReadonlyecrRepository

    ecrRepository: IRepository

    ECR Repository where the Build Host Image resides.

    +

    ReadonlyecrRepositoryImageTag

    ecrRepositoryImageTag: string

    Tag for the Build Host Image

    +

    ReadonlyprojectType

    projectType: ProjectType

    The type of project being built.

    +

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    +

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    +

    Optional ReadonlyenvironmentVariables

    environmentVariables?: { string: BuildEnvironmentVariable }

    Additional build environment variables to the build project.

    +

    ReadonlyencryptionKey

    encryptionKey: Key

    The encryption key use across

    +

    Optional ReadonlysourceCustomPath

    sourceCustomPath?: string

    Custom asset to be provided when using ProjectType.Custom

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Default

    - No description.
+
    + +

    Optional Readonlyenv

    env?: Environment

    The AWS environment (account/region) where this stack will be deployed.

    +

    Set the region/account fields of env to either a concrete value to +select the indicated environment (recommended for production stacks), or to +the values of environment variables +CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment +depend on the AWS credentials/configuration that the CDK CLI is executed +under (recommended for development stacks).

    +

    If the Stack is instantiated inside a Stage, any undefined +region/account fields from env will default to the same field on the +encompassing Stage, if configured there.

    +

    If either region or account are not set nor inherited from Stage, the +Stack will be considered "environment-agnostic"". Environment-agnostic +stacks can be deployed to any environment but may not be able to take +advantage of all features of the CDK. For example, they will not be able to +use environmental context lookups such as ec2.Vpc.fromLookup and will not +automatically translate Service Principals to the right format based on the +environment's AWS partition, and other such enhancements.

    +

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
+
    + +

    Default

      +
    • The environment of the containing Stage if available, +otherwise create the stack will be environment-agnostic.
      • +
    +

    Optional ReadonlystackName

    stackName?: string

    Name to deploy the stack with

    +

    Default

    - Derived from construct path.
+
    + +

    Optional Readonlytags

    tags?: { [key: string]: string }

    Stack tags that will be applied to all the taggable resources and the stack itself.

    +

    Default

    {}
+
    + +

    Optional ReadonlynotificationArns

    notificationArns?: string[]

    SNS Topic ARNs that will receive stack events.

    +

    Default

    - no notfication arns.
+
    + +

    Optional Readonlysynthesizer

    synthesizer?: IStackSynthesizer

    Synthesis method to use while deploying this stack

    +

    The Stack Synthesizer controls aspects of synthesis and deployment, +like how assets are referenced and what IAM roles to use. For more +information, see the README of the main CDK package.

    +

    If not specified, the defaultStackSynthesizer from App will be used. +If that is not specified, DefaultStackSynthesizer is used if +@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major +version is v2. In CDK v1 LegacyStackSynthesizer is the default if no +other synthesizer is specified.

    +

    Default

      +
    • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
      • +
    +

    Optional ReadonlyterminationProtection

    terminationProtection?: boolean

    Whether to enable termination protection for this stack.

    +

    Default

    false
+
    + +

    Optional ReadonlyanalyticsReporting

    analyticsReporting?: boolean

    Include runtime versioning information in this Stack

    +

    Default

    analyticsReporting setting of containing App, or value of +'aws:cdk:version-reporting' context key

    +

    Optional ReadonlycrossRegionReferences

    crossRegionReferences?: boolean

    Enable this flag to allow native cross region stack references.

    +

    Enabling this will create a CloudFormation custom resource +in both the producing stack and consuming stack in order to perform the export/import

    +

    This feature is currently experimental

    +

    Default

    false
+
    + +

    Optional ReadonlypermissionsBoundary

    permissionsBoundary?: PermissionsBoundary

    Options for applying a permissions boundary to all IAM Roles +and Users created within this Stage

    +

    Default

    - no permissions boundary is applied
+
    + +

    Optional ReadonlysuppressTemplateIndentation

    suppressTemplateIndentation?: boolean

    Enable this flag to suppress indentation in generated +CloudFormation templates.

    +

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation +context key will be used. If that is not specified, then the +default value false will be used.

    +

    Default

      +
    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
      • +
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/EmbeddedLinuxCodebuildProjectProps.html b/interfaces/EmbeddedLinuxCodebuildProjectProps.html deleted file mode 100644 index 388b3ce..0000000 --- a/interfaces/EmbeddedLinuxCodebuildProjectProps.html +++ /dev/null @@ -1,114 +0,0 @@ -EmbeddedLinuxCodebuildProjectProps | aws4embeddedlinux-cdk-lib

    Interface EmbeddedLinuxCodebuildProjectProps

    Properties to allow customizing the build.

    -
    interface EmbeddedLinuxCodebuildProjectProps {
        imageRepo: IRepository;
        imageTag?: string;
        vpc: IVpc;
        projectKind?: ProjectKind;
        layerRepoName?: string;
        buildPolicyAdditions?: PolicyStatement[];
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        outputBucket?: Bucket | VMImportBucket;
        subDirectoryName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxCodebuildProjectProps

    Properties

    imageRepo -imageTag? -vpc -projectKind? -layerRepoName? -buildPolicyAdditions? -accessLoggingBucket? -serverAccessLogsPrefix? -artifactBucket? -outputBucket? -subDirectoryName? -description? -env? -stackName? -tags? -notificationArns? -synthesizer? -terminationProtection? -analyticsReporting? -crossRegionReferences? -permissionsBoundary? -suppressTemplateIndentation? -

    Properties

    ReadonlyimageRepo

    imageRepo: IRepository

    ECR Repository where the Build Host Image resides.

    -

    Optional ReadonlyimageTag

    imageTag?: string

    Tag for the Build Host Image

    -

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    -

    Optional ReadonlyprojectKind

    projectKind?: ProjectKind

    The type of project being built.

    -

    Optional ReadonlylayerRepoName

    layerRepoName?: string

    A name for the layer-repo that is created. Default is 'layer-repo'

    -

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    -

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    -

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    -

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    -

    Optional ReadonlyoutputBucket

    outputBucket?: Bucket | VMImportBucket

    Output bucket to use

    -

    Optional ReadonlysubDirectoryName

    subDirectoryName?: string

    Prefix for S3 object within bucket

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    -

    Default

    - No description.
-
    - -

    Optional Readonlyenv

    env?: Environment

    The AWS environment (account/region) where this stack will be deployed.

    -

    Set the region/account fields of env to either a concrete value to -select the indicated environment (recommended for production stacks), or to -the values of environment variables -CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment -depend on the AWS credentials/configuration that the CDK CLI is executed -under (recommended for development stacks).

    -

    If the Stack is instantiated inside a Stage, any undefined -region/account fields from env will default to the same field on the -encompassing Stage, if configured there.

    -

    If either region or account are not set nor inherited from Stage, the -Stack will be considered "environment-agnostic"". Environment-agnostic -stacks can be deployed to any environment but may not be able to take -advantage of all features of the CDK. For example, they will not be able to -use environmental context lookups such as ec2.Vpc.fromLookup and will not -automatically translate Service Principals to the right format based on the -environment's AWS partition, and other such enhancements.

    -

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
-
    - -

    Default

      -
    • The environment of the containing Stage if available, -otherwise create the stack will be environment-agnostic.
      • -
    -

    Optional ReadonlystackName

    stackName?: string

    Name to deploy the stack with

    -

    Default

    - Derived from construct path.
-
    - -

    Optional Readonlytags

    tags?: { [key: string]: string }

    Stack tags that will be applied to all the taggable resources and the stack itself.

    -

    Default

    {}
-
    - -

    Optional ReadonlynotificationArns

    notificationArns?: string[]

    SNS Topic ARNs that will receive stack events.

    -

    Default

    - no notfication arns.
-
    - -

    Optional Readonlysynthesizer

    synthesizer?: IStackSynthesizer

    Synthesis method to use while deploying this stack

    -

    The Stack Synthesizer controls aspects of synthesis and deployment, -like how assets are referenced and what IAM roles to use. For more -information, see the README of the main CDK package.

    -

    If not specified, the defaultStackSynthesizer from App will be used. -If that is not specified, DefaultStackSynthesizer is used if -@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major -version is v2. In CDK v1 LegacyStackSynthesizer is the default if no -other synthesizer is specified.

    -

    Default

      -
    • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
      • -
    -

    Optional ReadonlyterminationProtection

    terminationProtection?: boolean

    Whether to enable termination protection for this stack.

    -

    Default

    false
-
    - -

    Optional ReadonlyanalyticsReporting

    analyticsReporting?: boolean

    Include runtime versioning information in this Stack

    -

    Default

    analyticsReporting setting of containing App, or value of -'aws:cdk:version-reporting' context key

    -

    Optional ReadonlycrossRegionReferences

    crossRegionReferences?: boolean

    Enable this flag to allow native cross region stack references.

    -

    Enabling this will create a CloudFormation custom resource -in both the producing stack and consuming stack in order to perform the export/import

    -

    This feature is currently experimental

    -

    Default

    false
-
    - -

    Optional ReadonlypermissionsBoundary

    permissionsBoundary?: PermissionsBoundary

    Options for applying a permissions boundary to all IAM Roles -and Users created within this Stage

    -

    Default

    - no permissions boundary is applied
-
    - -

    Optional ReadonlysuppressTemplateIndentation

    suppressTemplateIndentation?: boolean

    Enable this flag to suppress indentation in generated -CloudFormation templates.

    -

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation -context key will be used. If that is not specified, then the -default value false will be used.

    -

    Default

      -
    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
      • -
    -

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/EmbeddedLinuxPipelineProps.html b/interfaces/EmbeddedLinuxPipelineProps.html deleted file mode 100644 index 29e67cd..0000000 --- a/interfaces/EmbeddedLinuxPipelineProps.html +++ /dev/null @@ -1,114 +0,0 @@ -EmbeddedLinuxPipelineProps | aws4embeddedlinux-cdk-lib

    Interface EmbeddedLinuxPipelineProps

    Properties to allow customizing the build.

    -
    interface EmbeddedLinuxPipelineProps {
        imageRepo: IRepository;
        imageTag?: string;
        vpc: IVpc;
        projectKind?: ProjectKind;
        layerRepoName?: string;
        buildPolicyAdditions?: PolicyStatement[];
        accessLoggingBucket?: Bucket;
        serverAccessLogsPrefix?: string;
        artifactBucket?: Bucket;
        outputBucket?: Bucket | VMImportBucket;
        subDirectoryName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxPipelineProps

    Properties

    imageRepo -imageTag? -vpc -projectKind? -layerRepoName? -buildPolicyAdditions? -accessLoggingBucket? -serverAccessLogsPrefix? -artifactBucket? -outputBucket? -subDirectoryName? -description? -env? -stackName? -tags? -notificationArns? -synthesizer? -terminationProtection? -analyticsReporting? -crossRegionReferences? -permissionsBoundary? -suppressTemplateIndentation? -

    Properties

    ReadonlyimageRepo

    imageRepo: IRepository

    ECR Repository where the Build Host Image resides.

    -

    Optional ReadonlyimageTag

    imageTag?: string

    Tag for the Build Host Image

    -

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    -

    Optional ReadonlyprojectKind

    projectKind?: ProjectKind

    The type of project being built.

    -

    Optional ReadonlylayerRepoName

    layerRepoName?: string

    A name for the layer-repo that is created. Default is 'layer-repo'

    -

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    -

    Optional ReadonlyaccessLoggingBucket

    accessLoggingBucket?: Bucket

    Access logging bucket to use

    -

    Optional ReadonlyserverAccessLogsPrefix

    serverAccessLogsPrefix?: string

    Access logging prefix to use

    -

    Optional ReadonlyartifactBucket

    artifactBucket?: Bucket

    Artifact bucket to use

    -

    Optional ReadonlyoutputBucket

    outputBucket?: Bucket | VMImportBucket

    Output bucket to use

    -

    Optional ReadonlysubDirectoryName

    subDirectoryName?: string

    Prefix for S3 object within bucket

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    -

    Default

    - No description.
-
    - -

    Optional Readonlyenv

    env?: Environment

    The AWS environment (account/region) where this stack will be deployed.

    -

    Set the region/account fields of env to either a concrete value to -select the indicated environment (recommended for production stacks), or to -the values of environment variables -CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment -depend on the AWS credentials/configuration that the CDK CLI is executed -under (recommended for development stacks).

    -

    If the Stack is instantiated inside a Stage, any undefined -region/account fields from env will default to the same field on the -encompassing Stage, if configured there.

    -

    If either region or account are not set nor inherited from Stage, the -Stack will be considered "environment-agnostic"". Environment-agnostic -stacks can be deployed to any environment but may not be able to take -advantage of all features of the CDK. For example, they will not be able to -use environmental context lookups such as ec2.Vpc.fromLookup and will not -automatically translate Service Principals to the right format based on the -environment's AWS partition, and other such enhancements.

    -

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
-
    - -

    Default

      -
    • The environment of the containing Stage if available, -otherwise create the stack will be environment-agnostic.
      • -
    -

    Optional ReadonlystackName

    stackName?: string

    Name to deploy the stack with

    -

    Default

    - Derived from construct path.
-
    - -

    Optional Readonlytags

    tags?: { [key: string]: string }

    Stack tags that will be applied to all the taggable resources and the stack itself.

    -

    Default

    {}
-
    - -

    Optional ReadonlynotificationArns

    notificationArns?: string[]

    SNS Topic ARNs that will receive stack events.

    -

    Default

    - no notfication arns.
-
    - -

    Optional Readonlysynthesizer

    synthesizer?: IStackSynthesizer

    Synthesis method to use while deploying this stack

    -

    The Stack Synthesizer controls aspects of synthesis and deployment, -like how assets are referenced and what IAM roles to use. For more -information, see the README of the main CDK package.

    -

    If not specified, the defaultStackSynthesizer from App will be used. -If that is not specified, DefaultStackSynthesizer is used if -@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major -version is v2. In CDK v1 LegacyStackSynthesizer is the default if no -other synthesizer is specified.

    -

    Default

      -
    • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
      • -
    -

    Optional ReadonlyterminationProtection

    terminationProtection?: boolean

    Whether to enable termination protection for this stack.

    -

    Default

    false
-
    - -

    Optional ReadonlyanalyticsReporting

    analyticsReporting?: boolean

    Include runtime versioning information in this Stack

    -

    Default

    analyticsReporting setting of containing App, or value of -'aws:cdk:version-reporting' context key

    -

    Optional ReadonlycrossRegionReferences

    crossRegionReferences?: boolean

    Enable this flag to allow native cross region stack references.

    -

    Enabling this will create a CloudFormation custom resource -in both the producing stack and consuming stack in order to perform the export/import

    -

    This feature is currently experimental

    -

    Default

    false
-
    - -

    Optional ReadonlypermissionsBoundary

    permissionsBoundary?: PermissionsBoundary

    Options for applying a permissions boundary to all IAM Roles -and Users created within this Stage

    -

    Default

    - no permissions boundary is applied
-
    - -

    Optional ReadonlysuppressTemplateIndentation

    suppressTemplateIndentation?: boolean

    Enable this flag to suppress indentation in generated -CloudFormation templates.

    -

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation -context key will be used. If that is not specified, then the -default value false will be used.

    -

    Default

      -
    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
      • -
    -

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html new file mode 100644 index 0000000..124a998 --- /dev/null +++ b/interfaces/PipelineResourcesProps.html @@ -0,0 +1,104 @@ +PipelineResourcesProps | aws4embeddedlinux-cdk-lib

    Interface PipelineResourcesProps

    Select options for the PipelineResourcesStack.

    +
    interface PipelineResourcesProps {
        resource_prefix: string;
        ecrRepositoryName?: string;
        pipelineArtifactBucketName?: string;
        pipelineSourceBucketName?: string;
        pipelineOutputBucketName?: string;
        loggingBucketName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • PipelineResourcesProps

    Properties

    resource_prefix +ecrRepositoryName? +pipelineArtifactBucketName? +pipelineSourceBucketName? +pipelineOutputBucketName? +loggingBucketName? +description? +env? +stackName? +tags? +notificationArns? +synthesizer? +terminationProtection? +analyticsReporting? +crossRegionReferences? +permissionsBoundary? +suppressTemplateIndentation? +

    Properties

    Readonlyresource_prefix

    resource_prefix: string

    The resource prefix

    +

    Optional ReadonlyecrRepositoryName

    ecrRepositoryName?: string

    The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

    +

    Optional ReadonlypipelineArtifactBucketName

    pipelineArtifactBucketName?: string

    The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

    +

    Optional ReadonlypipelineSourceBucketName

    pipelineSourceBucketName?: string

    The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

    +

    Optional ReadonlypipelineOutputBucketName

    pipelineOutputBucketName?: string

    The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

    +

    Optional ReadonlyloggingBucketName

    loggingBucketName?: string

    Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Default

    - No description.
+
    + +

    Optional Readonlyenv

    env?: Environment

    The AWS environment (account/region) where this stack will be deployed.

    +

    Set the region/account fields of env to either a concrete value to +select the indicated environment (recommended for production stacks), or to +the values of environment variables +CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment +depend on the AWS credentials/configuration that the CDK CLI is executed +under (recommended for development stacks).

    +

    If the Stack is instantiated inside a Stage, any undefined +region/account fields from env will default to the same field on the +encompassing Stage, if configured there.

    +

    If either region or account are not set nor inherited from Stage, the +Stack will be considered "environment-agnostic"". Environment-agnostic +stacks can be deployed to any environment but may not be able to take +advantage of all features of the CDK. For example, they will not be able to +use environmental context lookups such as ec2.Vpc.fromLookup and will not +automatically translate Service Principals to the right format based on the +environment's AWS partition, and other such enhancements.

    +

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
+
    + +

    Default

      +
    • The environment of the containing Stage if available, +otherwise create the stack will be environment-agnostic.
      • +
    +

    Optional ReadonlystackName

    stackName?: string

    Name to deploy the stack with

    +

    Default

    - Derived from construct path.
+
    + +

    Optional Readonlytags

    tags?: { [key: string]: string }

    Stack tags that will be applied to all the taggable resources and the stack itself.

    +

    Default

    {}
+
    + +

    Optional ReadonlynotificationArns

    notificationArns?: string[]

    SNS Topic ARNs that will receive stack events.

    +

    Default

    - no notfication arns.
+
    + +

    Optional Readonlysynthesizer

    synthesizer?: IStackSynthesizer

    Synthesis method to use while deploying this stack

    +

    The Stack Synthesizer controls aspects of synthesis and deployment, +like how assets are referenced and what IAM roles to use. For more +information, see the README of the main CDK package.

    +

    If not specified, the defaultStackSynthesizer from App will be used. +If that is not specified, DefaultStackSynthesizer is used if +@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major +version is v2. In CDK v1 LegacyStackSynthesizer is the default if no +other synthesizer is specified.

    +

    Default

      +
    • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
      • +
    +

    Optional ReadonlyterminationProtection

    terminationProtection?: boolean

    Whether to enable termination protection for this stack.

    +

    Default

    false
+
    + +

    Optional ReadonlyanalyticsReporting

    analyticsReporting?: boolean

    Include runtime versioning information in this Stack

    +

    Default

    analyticsReporting setting of containing App, or value of +'aws:cdk:version-reporting' context key

    +

    Optional ReadonlycrossRegionReferences

    crossRegionReferences?: boolean

    Enable this flag to allow native cross region stack references.

    +

    Enabling this will create a CloudFormation custom resource +in both the producing stack and consuming stack in order to perform the export/import

    +

    This feature is currently experimental

    +

    Default

    false
+
    + +

    Optional ReadonlypermissionsBoundary

    permissionsBoundary?: PermissionsBoundary

    Options for applying a permissions boundary to all IAM Roles +and Users created within this Stage

    +

    Default

    - no permissions boundary is applied
+
    + +

    Optional ReadonlysuppressTemplateIndentation

    suppressTemplateIndentation?: boolean

    Enable this flag to suppress indentation in generated +CloudFormation templates.

    +

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation +context key will be used. If that is not specified, then the +default value false will be used.

    +

    Default

      +
    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
      • +
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html deleted file mode 100644 index ca0b301..0000000 --- a/interfaces/SourceRepoProps.html +++ /dev/null @@ -1,95 +0,0 @@ -SourceRepoProps | aws4embeddedlinux-cdk-lib

    Interface SourceRepoProps

    interface SourceRepoProps {
        repoName: string;
        kind: ProjectKind;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • SourceRepoProps

    Properties

    repoName -kind -description? -env? -stackName? -tags? -notificationArns? -synthesizer? -terminationProtection? -analyticsReporting? -crossRegionReferences? -permissionsBoundary? -suppressTemplateIndentation? -

    Properties

    ReadonlyrepoName

    repoName: string

    The name of the CodeCommit Repository created.

    -

    Readonlykind

    kind: ProjectKind

    The type of project to seed this repository with.

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    -

    Default

    - No description.
-
    - -

    Optional Readonlyenv

    env?: Environment

    The AWS environment (account/region) where this stack will be deployed.

    -

    Set the region/account fields of env to either a concrete value to -select the indicated environment (recommended for production stacks), or to -the values of environment variables -CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment -depend on the AWS credentials/configuration that the CDK CLI is executed -under (recommended for development stacks).

    -

    If the Stack is instantiated inside a Stage, any undefined -region/account fields from env will default to the same field on the -encompassing Stage, if configured there.

    -

    If either region or account are not set nor inherited from Stage, the -Stack will be considered "environment-agnostic"". Environment-agnostic -stacks can be deployed to any environment but may not be able to take -advantage of all features of the CDK. For example, they will not be able to -use environmental context lookups such as ec2.Vpc.fromLookup and will not -automatically translate Service Principals to the right format based on the -environment's AWS partition, and other such enhancements.

    -

    Example

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
-
    - -

    Default

      -
    • The environment of the containing Stage if available, -otherwise create the stack will be environment-agnostic.
      • -
    -

    Optional ReadonlystackName

    stackName?: string

    Name to deploy the stack with

    -

    Default

    - Derived from construct path.
-
    - -

    Optional Readonlytags

    tags?: { [key: string]: string }

    Stack tags that will be applied to all the taggable resources and the stack itself.

    -

    Default

    {}
-
    - -

    Optional ReadonlynotificationArns

    notificationArns?: string[]

    SNS Topic ARNs that will receive stack events.

    -

    Default

    - no notfication arns.
-
    - -

    Optional Readonlysynthesizer

    synthesizer?: IStackSynthesizer

    Synthesis method to use while deploying this stack

    -

    The Stack Synthesizer controls aspects of synthesis and deployment, -like how assets are referenced and what IAM roles to use. For more -information, see the README of the main CDK package.

    -

    If not specified, the defaultStackSynthesizer from App will be used. -If that is not specified, DefaultStackSynthesizer is used if -@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major -version is v2. In CDK v1 LegacyStackSynthesizer is the default if no -other synthesizer is specified.

    -

    Default

      -
    • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
      • -
    -

    Optional ReadonlyterminationProtection

    terminationProtection?: boolean

    Whether to enable termination protection for this stack.

    -

    Default

    false
-
    - -

    Optional ReadonlyanalyticsReporting

    analyticsReporting?: boolean

    Include runtime versioning information in this Stack

    -

    Default

    analyticsReporting setting of containing App, or value of -'aws:cdk:version-reporting' context key

    -

    Optional ReadonlycrossRegionReferences

    crossRegionReferences?: boolean

    Enable this flag to allow native cross region stack references.

    -

    Enabling this will create a CloudFormation custom resource -in both the producing stack and consuming stack in order to perform the export/import

    -

    This feature is currently experimental

    -

    Default

    false
-
    - -

    Optional ReadonlypermissionsBoundary

    permissionsBoundary?: PermissionsBoundary

    Options for applying a permissions boundary to all IAM Roles -and Users created within this Stage

    -

    Default

    - no permissions boundary is applied
-
    - -

    Optional ReadonlysuppressTemplateIndentation

    suppressTemplateIndentation?: boolean

    Enable this flag to suppress indentation in generated -CloudFormation templates.

    -

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation -context key will be used. If that is not specified, then the -default value false will be used.

    -

    Default

      -
    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
      • -
    -

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/media/architecture.svg b/media/architecture-v0.2.x.svg similarity index 66% rename from media/architecture.svg rename to media/architecture-v0.2.x.svg index 212e576..30005bf 100644 --- a/media/architecture.svg +++ b/media/architecture-v0.2.x.svg @@ -1,4 +1,4 @@ -
    AWS Account
    AWS Account
    CodePipeline
    CodePipeline
    Build Artifacts
    Build Artifacts
    Build and Download Cache
    Build and Download Cache
    CodeBuild
    CodeBuild
    Update Config
    Update Config
    Builder
    Build...
    CodeCommit
    Repository
    CodeCommit...
    Download Sources
    Download Sources
    Upstream Package Sources
    Upstream Package Sourc...
    S3
    S3
    EFS
    EFS
    Download Metadata
    Download Metadata
    Upstream Layers
    Upstream Layers    Text is not SVG - cannot display     +
    AWS Account
    AWS Account
    CodePipeline
    CodePipeline
    Build Artifacts
    Build Artifacts
    Build and Download Cache
    Build and Download Cache
    CodeBuild
    CodeBuild
    Update Config
    Update Config
    Builder
    Build...
    S3
    Bucket
    S3
    Bucket
    Download Sources
    Download Sources
    Upstream Package Sources
    Upstream Package Sourc...
    S3
    Bucket
    S3
    Bucket
    EFS
    EFS
    Download Metadata
    Download Metadata
    Upstream Layers
    Upstream Layers    Text is not SVG - cannot display diff --git a/modules.html b/modules.html index 4359cdc..1a4e412 100644 --- a/modules.html +++ b/modules.html @@ -1 +1 @@ -aws4embeddedlinux-cdk-lib

    aws4embeddedlinux-cdk-lib

    Enumerations

    ImageKind
    ProjectKind

    Classes

    BuildImageDataStack
    BuildImagePipelineStack
    BuildImageRepoStack
    SourceRepo
    EmbeddedLinuxCodebuildProjectStack
    EmbeddedLinuxPipelineStack
    PipelineNetworkStack

    Interfaces

    BuildImageDataProps
    BuildImagePipelineProps
    SourceRepoProps
    EmbeddedLinuxCodebuildProjectProps
    EmbeddedLinuxPipelineProps

    Settings

    Member Visibility

    On This Page

    Enumerations
    Classes
    Interfaces
    +aws4embeddedlinux-cdk-lib

    aws4embeddedlinux-cdk-lib

    Enumerations

    ProjectType

    Classes

    EmbeddedLinuxCodeBuildProjectStack
    EmbeddedLinuxCodePipelineBaseImageStack
    EmbeddedLinuxCodePipelineStack
    PipelineResourcesStack

    Interfaces

    EmbeddedLinuxCodeBuildProjectProps
    EmbeddedLinuxCodePipelineBaseImageProps
    EmbeddedLinuxCodePipelineProps
    PipelineResourcesProps

    Functions

    isBucketVersioned

    Settings

    Member Visibility

    On This Page

    Enumerations
    Classes
    Interfaces
    Functions
    From ee0dfaa00fc5c4ead3f02e68f58f61bb1152b1df Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Thu, 27 Mar 2025 10:49:05 +0000 Subject: [PATCH 28/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@1c5a4d085363fd2b9ab30b206e?= =?UTF-8?q?5aa4e786b076ad=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- assets/navigation.js | 2 +- assets/search.js | 2 +- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ functions/isBucketVersioned.html | 1 - index.html | 6 ++-- .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- modules.html | 2 +- 14 files changed, 66 insertions(+), 67 deletions(-) delete mode 100644 functions/isBucketVersioned.html diff --git a/assets/navigation.js b/assets/navigation.js index fcf930a..001ea54 100644 --- a/assets/navigation.js +++ b/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJydk01Lw0AQhv/LnIPBoqXkGPEgeAgqXsTDuvvWTpPshp1dqEj/u6BIGpImTc7zfj2HefumgEOgjO7rDxgD88g2Hu6cQR65MoV3e+hQeNcIJdSosKOM2Ab4rdKQdNp2tQt1RQmVbA1lq9v1Mbms9DkoXbalulIiU42/nm7j9Woz1lhwg4otciV4qNUnZrAOe2cB9yIupR42LkJfQLwcdC7fJNa/8AnioteQ8zjD0jGMnuPM/GHd2GyWPOoS4RVe2FmYNnQbrQ7srKQ9UTdxfXM69e8DXr4atFGwsZb05NQN2BzffwDRUm8P" \ No newline at end of file +window.navigationData = "eJydks8LgjAYhv+X7yxJQiEejQ5BB6lu0WFtX7mcU7YJRvi/B0WYOH+e977v8z2w8wsMlgYC2KZXZAzZnsui3GQMw4ILFqnsgdREKss1OJATE0MAXBpUN0JRu8O1RWxSAQ4kXDIIvNW6csZBj4bQpIZSQbQeIn46TeLS8/uIEc9RcIkh0bhLyR0nuNq7k4RbE2Ot7cVZ6jOM54tO9RvU+gUPqLNCUdTdOvZon0ar0XG+Pdd79vfDnp451nMoi1S7f0/NBb+6vAHoH1JS" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js index 1eae977..0144565 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "eJy9m01v2zgQhv8LcxVS88tft3bRQ9FFN9sWvRhBochMqo0taSU5myDIf19Qoq2hh5IpWe7JgcOZeUk+HA4p+ZXk6X8FWa5eyWOcrMlyKgKShFtFliQuPuyiR1X+UHkRp4lak4Ds8g1ZkvtdEpVxmhTvUJvrX+V2QwISbcKiUAVZEvIW7J3PD75v8vQfFZXfXzJ18KqS3bZ4B/7T6YtOG2fp48sJL1dZ3Qa4CkgW5iopj9Q4I/z9cbs7FeFfVbUZGEH34f029ulGWDUbGOdzWJyK8Vg1Gej/q0pUcTpGfmg2MM6X5+zT9vlUmOQ5i6tWA6P8ka7Vh128WZ8KFKVrdWcaDo21K8p0ezLQvlWfKEw2YT5u79R6rdZ/xsnu+dA/Y3eTp1kzd3FSqvw+jFTx7rRV92KdsCavqCj/qrK0iMs0fzkj2JWK8hw6cg+JR4d9hH7ahg/qe/gwmuBYOywrh2MLf8qic2TW5mOLqpbHTbqJo5f363Vc7R/nqKz8ZZW/EPgbHYIkyl8y7f2zOo/Wg6NHNRatbO63rr+VYfR4EG8idyuvTDoXtaTsED1Kk6LMd1GZ5kPDXNk+BgxP3UvPtHcTZ2oTJ+pDWKhqbfvnPrepfwLMjP23dJdHqi6gzg18tXdaVE7v9k49h7FlNLw6cJOr+/h55A5ke6cX7cD7vIzvw6gceQ5C4/ays9B/H+3SPnAz7Sm5dzLtlDwso56W3JVWkbVnbnXbXSbBdsQalmVbOt0LzEFqx6LSXy+q887X3b/SO6nfa2vrv6P97o1s9P3rstvW6LvVpTepC+xNvSSPM8Z7yRcd5b92ZbYbaYzTytdFR7iWO8741nIvMrrDa5TxSpMLnfFPCR2e9bsBcNyc9p332kVZuxhTnO/Fg0NUr0sHLzGDLxwc6s67bPAjMXmK8zTZqqT8EeZxeLdRg+UCX0/A17hyh5by41XwnQLrnbm+Vb0Jy19DNdZ+6nvXrPZzrkyf80XPY8VvOE2MdYjoqmX3bb6awqporWHdLf1r19zY/cxa99COEFfYvOVC3t0hn93oi/6upyxrB0pqB2MIc9eiQxS669ALSIWHknOEwgPJBWTCuvMcmbDmHFHmJn14iJOH4fqMg1GEgbyJGrvzpbvZKHmyw7VXfmzpgUdl5aOgq5zqF7n7NqdLg1/d3k/NiUOxj6yeJ+Fh+pxXIn3Ued2DDNPmPOr20eZ1vu2nzcozvURZCWYs5p3FrRfzXhVtm5rbgMTJWj2T5St5ql+pIUvCrvn1ggTkPlabtX5Zh+zzaLrVJT4JyDqNdtWft6bZD6WTj25ct343IcFqEvDZNaOz29tgtTeu/lF9sffRfFMZUhKsaMDZNZ3MLUOKDKllyEiwYq6IDBkyy5CTYMVdhhwZcstQkGAlXIYCGQrLUJJgJV2GEhlKy3BKgtXUZThFhlPLcEaC1cxlOEOGM8twToLV3GU4R4Zzy3BBgtXCZbhAhgsbAM0DdbJDMTz0iJ4KHxowcc2YsI0dANkEUc0FZQGbX8/EkTGGiNoUUc0G5U5jDBK1SaKaDyqc2GOYqE0T1YxQGbDpNePUNsZAUZsoqjmhTqYohoraVFHNCp05I2OwqE0W1bxQJ1sUw0Vtuqhmhi6co40BozZhTDPDJq7RZpgwZhPGNDOMuiIzTBg7ylGsFU/mSFM2YYy3zjPDhDGbMKaZYe78iAljNmFMts4zw4QxmzA2be8zJozZhLFZ65JkmDBmE8Y0M8yZ2hkmjNmEsXbCGCaM2YTxdsI4JozbhPF2wjgmjNuE8WobdO5KHBPGj3ZCzQyTTtmOzdAmjFeEOTMJx4RxmzAuWyHhmDBuE8anrZBwTBi3CeOztoKDY8C4DRift+Z8jgHjNmB80ZrzOQaM24CJCjDnji4wYMIGTNDWRCIwYMIGTFSAOdO2wIAJGzBRAeYsCwQGTByVW6I1CwlHxWUDJjQy3FlVCAyYsAETGhlOncYYMGEDJjQz3Jl5BSZM2IQJzQx3pjCBCRM2YUIzw90VKiZM2IRJzQx3V6mYMGkTJjUz3JkLJCZM2oRJzQx3si0xYdImTPJWSCQmTNqESdG6niUmTB4V9e0pTDrqepswOW3N+RITJm3C5Kx1q5KYMGkTJuetOV9iwqRNmKwIcyYDiQmTNmHTSWsammLCzFfVkfVJ5aVaf6qPrqsVcT8ueyU/zemWHo7ar4QKsnx9Cwhf6M+35lRbfXs42Or/1YoOb9o3/uaNu7mnF3BBB3TNgK5Zbctk/SmMTsn9IpgX9Rvni8a3X1eP7s+ATApkUiOTmc+pGU4jW8r+sZpH1yAmAzH3scwQ8Wn/GPUVRuOfA/9i5ufPPGHa6CdMBy7M0+2sfnAEOjABHZicH6CoL5xBgCkI4DkixwH2N2x3YaGqWcDdAKxTP9hPR0F9YWA2mDgvCuoC48D5mV3AysEyE35L9ejODoy1BGNt1hPjJh2YdTf1RMn5RB7IBplH+LmMi/rO86n5fV7jD8Du56361VdjD3rul0COrmHBwgbASr/E53hmBPyBZSapl7/9z8AaJ2C0/XJN20MDMIMgKTMDBzef0i8ddD0bBQMAlo/wWz5tb9IB9WBH5qyXU/tpAHAJGOJm1ch+evFDTTAMEFE/xt0vvAHFAC3ul/X2LvfvAxQo23GwFIXfWkJOUZbjAGDZb7rsB0sg2YHESRcm2ZlP2W+R4EfmQDkATfilA/e7tmDawAiziVl5nkRUPwsGroAnbwfVD3IbH7CDfj7g+3hgQsB8mE75TUP9S2Qw5IBqLweHX+c2PsDK8Mtl6AUZoAf0TPh5wy9hgTkDG4zwm7Xq6TgYaTBC1GQqPjfoe8zhbXBglCxXt29v/wN3JlW7"; \ No newline at end of file +window.searchData = "eJy9m0tv2zgQx78LcxVS8yU/bu2ih6KLbrYtejGCQpGZVBtb0kpyNkGQ776gHtbQQ8mULPfkwOHM/En+OBxS8ivJkv9yslq/ksco3pDVwiNxsFNkRW6y5B8VFt9fUkU8ss+2ZEVUvN/l78B/rn8Vuy3xSLgN8lzlZEXIm9f4on7rLHl8OeHlKq3aAFceSYNMxcWRGmuEvz/u9qci/KvKNiMj6D6830Uu3QjKZiPjfA7yUzEeyyYj/X9VscpPx8gOzUbG+fKcfto9nwoTP6dR2WpklD+Sjfqwj7abU4HCZKPu6oZjY+3zItmdDNS0GhKFyTbMx92d2mzU5s8o3j8f+lfb3WRJ2s5dFBcquw9Clb87bdW/WGdMHBSoMPuq0iSPiiR7OSPYlQqzDDqyD4lDh12EftoFD+p78DCZ4Eg7LEqHUwt/SsNzZFbmU4sql8dNso3Cl/ebTVRESXwOalelv7T0FwB/k0MQh9lLqr1/VufRenD0qKailS3c1vW3IggfD+LryP3KS5PeRS0pO0QPkzgvsn1YJNnYMFemjxHDU/XSMe3dRKnaRrH6EOSqXNvuuc9u6p4A09r+W7LPQvVhHz6q4tzAV43TvHR61zh1HMaO0XDqwE2m7qPniTuQNk4v2oH3WRHdB2Ex8RwEtdvLzsLwfbRP+8jNdKDkwcm0V/K4jHpacl9aRdaOudVud5kE2xNrXJbt6PQgMEepnYpKd72ozjtf9/BK76R+p61t+I72uzeyyfevy25bk+9Wl96kLrA3DZI8zRg3ki86yn/ti3Q/0Rgnpa+LjnAld5rxreReZHTH1yjTlSYXOuOfEjo+6/cDYLk5HTrvlYuicjGlONeLB4uoQZcOTmJGXzhY1J132eBGYvwUZUm8U3HxI8ii4G6rRssFvp6Ar2nlji3lp6vgewVWO3N1q3oTFL/Gaqz8VPeuaeXnXJku54uBx4rfcJqY6hDRV8s2bb7WhVXeWcPaW7rXrllt9zPt3EN7Qlxh844LeXuHXHajL/q7gbKMHSiuHEwhzF6LjlFor0MvIBUeSs4RCg8kF5AJ685zZMKac0KZ2+ThIYofxuurHUwiDORN1NieL+3NJsmTPa6d8mNHDxwqKxcFfeXUsMj9tzl9Gtzq9mFqThyKXWQNPAmP02e9EhmizukeZJw261F3iDan8+0wbUaeGSTKSDBTMW8tbp2Yd6pou9TceiSKN+qZrF7Jk8ryKInJirBrfr0kHrmP1Haj36chTR5NdrrEJx7ZJOG+/PO2bvZD6eSjG1et382It555nF4vhX97660b4/If5ReNj/ab0pASb009Pr+eSWEYUmRIDUNGvDWzGTJkyAxDTrw1txlyZMgNQ0G8tbAZCmQoDENJvLW0GUpkKA1Dn3hr32boI0PfMJwTbz23Gc6R4dwwXBBvvbAZLpDhwjBcEm+9tBkukeHSBEDzQGceE9czn5oIYHjoET0lPtRji2u5ODK2AGQSRDUXlFmNMUTUpIhqNii3IU8xSNQkiWo+qPCYfz3zF6YxhomaNFHNCLXyRDFQ1CSKak6ob42MoaImVVSzQq1cUQwWNcmimhe6sI42houadFHNDF1aRxsDRk3CmGaGzWyRGSaMmYQx2oknw4SxoxzFOueZWdKUSRjTzDBrbmSYMGYSxkTnPDNMGDMJY7K7z5gwZhLG/M4lyTBhzCSMaWaYPa1jwphJGOsmjGHCmEkY6yaMYcKYSRjvJoxjwrhJGNfMMPuOhAnjJmG83AaFTTbHhPGjnbAkzJpJuGUzNAnjohMSjgnjJmFcdkLCMWHcJIz7XcUGx4BxEzA+78z5HAPGTcD4ojPncwwYNwHjGhlm3c05BoybgIlZZyIRGDBhAiZKwKxpW2DAhAmYKAGzlgQCAyZMwATvzEICAyaOyi2NDLPWFMJScZmACY0Mn1mNMWDCBExoZrg18wpMmDAJE5oZbk1hAhMmTMKEZoZbc4HAhAmTMKGZ4fYKFRMmTMKkZobbq1RMmDQJk5oZbmVbYsKkSZhknZBITJg0CZO8cz1LTJg0CZPdKUxiwuRRUS87c7601PUmYdLv3KokJkyahMl5Z86XmDBpEiZLwqzJQGLCpEmYXHamIYkJq78qT51PKivU5lN1+lyvif2J1yv5WR9QKW9Oy6+EcrJ6ffMIX+jPt/ZgWn57OJvq/1WKDi/Lt/7mrbu5oxdwxwZ0+UCXX9kyUX2KWqdkbhHqd+1b54vWt1tXj67AgMwZkDmrZdL6U9bDWcuWYnis9ukziElBzCZWPURcDo9R3UK0/jnwL3w3f/VDoq1+SHTgon5AnVbPftoAy9b/8nz3eXVjDMZHgvFxHI/jAM0V2V2Qq3IOUCcoIJ26oX46CuoLA3PB+HlRUBcYA87P7AJWDhaZcFuoR5duYKwFGOt6NTFWJ4N61UlHlKyP1IFskHe4m8vyh1atB6DVbcEf3XyChQgQk26JyvKYBvgDC0POnPw1v7xqnYDxccsNXff0YMxBEmX1dPJmWt0WcN/jSDAAAHjhBnzXy2tAPdhBOR3k1LyABy4BQ7zmXA7Ti58jgmGAiLoxbn/HDCgGaHG3PNW4bB7B5zg/gY1CuK0l5BTlJQ4AlsOmy3yWA9ITSHV0Uaen+lMOWyT4KTVQDkATbunA/norUA5GmC5r5Y5ElL/EBa6AJ2cH5W9gQQ8BRG4+4CtwrR+QT5p04jYN1Y9/AYEgMTk5OPwgtvUBk66jj6N3UsAAgZ4JN2/4vSfQPbDBCLdZKx9Ig1kHI0TrTMXnNfoOc3jrHRglq/Xt29v/wSkIxg=="; \ No newline at end of file diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 2cdea17..880214f 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib

    Class EmbeddedLinuxCodeBuildProjectStack

    The stack for creating a build pipeline.

    See EmbeddedLinuxCodeBuildProjectProps for configration options.

    -

    Hierarchy

    • Stack
      • EmbeddedLinuxCodeBuildProjectStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • EmbeddedLinuxCodeBuildProjectStack

    Constructors

    constructor

    Properties

    tags templateOptions region @@ -50,7 +50,7 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index f3734e7..18ee9a7 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib

    Class EmbeddedLinuxCodePipelineBaseImageStack

    The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

    For configuration options see BuildBaseImageCodePipelineProps.

    -

    Hierarchy

    • Stack
      • EmbeddedLinuxCodePipelineBaseImageStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • EmbeddedLinuxCodePipelineBaseImageStack

    Constructors

    constructor

    Properties

    ecrRepository ecrRepositoryImageTag tags @@ -53,9 +53,9 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    ReadonlyecrRepository

    ecrRepository: IRepository

    The ECR Repository where the image is located.

    -

    ReadonlyecrRepositoryImageTag

    ecrRepositoryImageTag: string

    The ECR Image Tag to find the base imaged.

    -

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    ReadonlyecrRepository

    ecrRepository: IRepository

    The ECR Repository where the image is located.

    +

    ReadonlyecrRepositoryImageTag

    ecrRepositoryImageTag: string

    The ECR Image Tag to find the base imaged.

    +

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/EmbeddedLinuxCodePipelineStack.html b/classes/EmbeddedLinuxCodePipelineStack.html index 941345b..4a5b0c0 100644 --- a/classes/EmbeddedLinuxCodePipelineStack.html +++ b/classes/EmbeddedLinuxCodePipelineStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodePipelineStack | aws4embeddedlinux-cdk-lib

    Class EmbeddedLinuxCodePipelineStack

    The stack for creating a build pipeline.

    See EmbeddedLinuxCodePipelineProps for configration options.

    -

    Hierarchy

    • Stack
      • EmbeddedLinuxCodePipelineStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • EmbeddedLinuxCodePipelineStack

    Constructors

    constructor

    Properties

    tags templateOptions region @@ -50,7 +50,7 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/classes/PipelineResourcesStack.html b/classes/PipelineResourcesStack.html index deb1d81..e9afc54 100644 --- a/classes/PipelineResourcesStack.html +++ b/classes/PipelineResourcesStack.html @@ -1,5 +1,5 @@ PipelineResourcesStack | aws4embeddedlinux-cdk-lib

    Class PipelineResourcesStack

    Input (Source) data for our PipelineResourcesStack.

    -

    Hierarchy

    • Stack
      • PipelineResourcesStack

    Constructors

    constructor +

    Hierarchy

    • Stack
      • PipelineResourcesStack

    Constructors

    constructor

    Properties

    vpc ecrRepository pipelineArtifactBucket @@ -56,14 +56,14 @@ _toCloudFormation isConstruct toString -

    Constructors

    constructor

    Properties

    Readonlyvpc

    vpc: IVpc

    The VPC for the pipeline to reside in.

    -

    ReadonlyecrRepository

    ecrRepository: IRepository

    The respository to put the build host container in.

    -

    ReadonlypipelineArtifactBucket

    pipelineArtifactBucket: Bucket

    The artifact bucket

    -

    ReadonlypipelineSourceBucket

    pipelineSourceBucket: Bucket

    The source bucket

    -

    ReadonlypipelineOutputBucket

    pipelineOutputBucket: Bucket

    The output bucket

    -

    Optional ReadonlyloggingBucket

    loggingBucket?: Bucket

    The Cloudwatch logging bucket

    -

    ReadonlyencryptionKey

    encryptionKey: Key

    The encryption key use across

    -

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    +

    Constructors

    constructor

    Properties

    Readonlyvpc

    vpc: IVpc

    The VPC for the pipeline to reside in.

    +

    ReadonlyecrRepository

    ecrRepository: IRepository

    The respository to put the build host container in.

    +

    ReadonlypipelineArtifactBucket

    pipelineArtifactBucket: Bucket

    The artifact bucket

    +

    ReadonlypipelineSourceBucket

    pipelineSourceBucket: Bucket

    The source bucket

    +

    ReadonlypipelineOutputBucket

    pipelineOutputBucket: Bucket

    The output bucket

    +

    Optional ReadonlyloggingBucket

    loggingBucket?: Bucket

    The Cloudwatch logging bucket

    +

    ReadonlyencryptionKey

    encryptionKey: Key

    The encryption key use across

    +

    Readonlytags

    tags: TagManager

    Tags to be applied to the stack.

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    Readonlyregion

    region: string

    The AWS region into which this stack will be deployed (e.g. us-west-2).

    This value is resolved according to the following rules:

    diff --git a/enums/ProjectType.html b/enums/ProjectType.html index 4867a24..3025509 100644 --- a/enums/ProjectType.html +++ b/enums/ProjectType.html @@ -1,5 +1,5 @@ ProjectType | aws4embeddedlinux-cdk-lib

    Enumeration ProjectType

    The type of project built.

    -

    Enumeration Members

    Poky +

    Enumeration Members

    Poky QEmu PokyAmi Kas @@ -8,11 +8,11 @@ CodeBuild Custom

    Enumeration Members

    Poky

    Poky: "poky"

    Build core-image-minimal from poky.

    -

    QEmu

    QEmu: "qemu"

    Build the Qemu meta-aws Demonstration Distribution.

    -

    PokyAmi

    PokyAmi: "poky-ami"

    Build an EC2 AMI

    -

    Kas

    Kas: "kas"

    Build an kas based image

    -

    Renesas

    Renesas: "renesas"

    Build an Renesas image

    -

    NxpImx

    NxpImx: "nxp-imx"

    Build an IMX image using NXP layers.

    -

    CodeBuild

    CodeBuild: "codebuild"

    Build no pipeline, just CodeBuild project to connect with GitHub actions.

    -

    Custom

    Custom: "custom"

    Build an image using a custom buildspec and asstes.

    -

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    QEmu

    QEmu: "qemu"

    Build the Qemu meta-aws Demonstration Distribution.

    +

    PokyAmi

    PokyAmi: "poky-ami"

    Build an EC2 AMI

    +

    Kas

    Kas: "kas"

    Build an kas based image

    +

    Renesas

    Renesas: "renesas"

    Build an Renesas image

    +

    NxpImx

    NxpImx: "nxp-imx"

    Build an IMX image using NXP layers.

    +

    CodeBuild

    CodeBuild: "codebuild"

    Build no pipeline, just CodeBuild project to connect with GitHub actions.

    +

    Custom

    Custom: "custom"

    Build an image using a custom buildspec and asstes.

    +

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/functions/isBucketVersioned.html b/functions/isBucketVersioned.html deleted file mode 100644 index 6438a58..0000000 --- a/functions/isBucketVersioned.html +++ /dev/null @@ -1 +0,0 @@ -isBucketVersioned | aws4embeddedlinux-cdk-lib

    Function isBucketVersioned

    • isBucketVersioned(bucket: IBucket | Bucket): boolean

      Parameters

      • bucket: IBucket | Bucket

      Returns boolean

    Settings

    Member Visibility
    diff --git a/index.html b/index.html index 76d2e60..1ffb122 100644 --- a/index.html +++ b/index.html @@ -129,7 +129,7 @@

    of `yarn':

    -
    yarn add github:aws4embeddedlinux/aws4embeddedlinux-ci
    yarn install
+
    yarn add aws4embeddedlinux-cdk-lib@aws4embeddedlinux/aws4embeddedlinux-ci
    yarn install
 
    
 
 
    
@@ -148,7 +148,7 @@
 
    const projectPipeline = new EmbeddedLinuxCodePipelineStack(app, "demo-project", {
      projectType: ProjectType.Poky,
      ecrRepository: <ecrRepository>,
      ecrRepositoryImageTag: <ecrRepositoryImageTag>,
      pipelineSourceBucket: <SourceBucket>,
      pipelineArtifactBucket: <ArtifactBucket>,
      pipelineOutputBucket: <OutputBucket>,
      vpc: <vpc>,
      encryptionKey: <encryptionKey>,
    });
 
    
 
-
    Refer to the API Documentation and the sample for more details.
    
+
    Refer to the API Documentation and the sample for more details.
    
 
    Once you have completed the code of your application, you can deploy the CDK stack using:
    
 
    cdk deploy
 
    
@@ -160,7 +160,7 @@
 
    The 'Base Image' pipeline will run weekly by default to keep the container patched and up to date.
    Note

    -

    We recommend you to deploy first the 'Base Image' pipeline and once the pipeline completes successfully, then you can deploy the other pipelines in you application as described in the sample.

    +

    We recommend you to deploy first the 'Base Image' pipeline and once the pipeline completes successfully, then you can deploy the other pipelines in you application as described in the sample.

    Once your pipelines completes successfully, the Yocto deploy directory generated content will be pushed into a S3 bucket.

    Bask to the top

    diff --git a/interfaces/EmbeddedLinuxCodeBuildProjectProps.html b/interfaces/EmbeddedLinuxCodeBuildProjectProps.html index 7654f10..2479453 100644 --- a/interfaces/EmbeddedLinuxCodeBuildProjectProps.html +++ b/interfaces/EmbeddedLinuxCodeBuildProjectProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodeBuildProjectProps | aws4embeddedlinux-cdk-lib

    Interface EmbeddedLinuxCodeBuildProjectProps

    Properties to allow customizing the build.

    -
    interface EmbeddedLinuxCodeBuildProjectProps {
        ecrRepository: IRepository;
        ecrRepositoryImageTag: string;
        vpc: IVpc;
        buildPolicyAdditions?: PolicyStatement[];
        encryptionKey: Key;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxCodeBuildProjectProps

    Properties

    ecrRepository +
    interface EmbeddedLinuxCodeBuildProjectProps {
        ecrRepository: IRepository;
        ecrRepositoryImageTag: string;
        vpc: IVpc;
        buildPolicyAdditions?: PolicyStatement[];
        encryptionKey: Key;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxCodeBuildProjectProps

    Properties

    ecrRepository ecrRepositoryImageTag vpc buildPolicyAdditions? @@ -16,11 +16,11 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlyecrRepository

    ecrRepository: IRepository

    ECR Repository where the Build Host Image resides.

    -

    ReadonlyecrRepositoryImageTag

    ecrRepositoryImageTag: string

    Tag for the Build Host Image

    -

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    -

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    -

    ReadonlyencryptionKey

    encryptionKey: Key

    The encryption key use across

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    ReadonlyecrRepositoryImageTag

    ecrRepositoryImageTag: string

    Tag for the Build Host Image

    +

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    +

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    +

    ReadonlyencryptionKey

    encryptionKey: Key

    The encryption key use across

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    diff --git a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html index 13f94e7..07ab314 100644 --- a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineBaseImageProps | aws4embeddedlinux-cdk-lib

    Interface EmbeddedLinuxCodePipelineBaseImageProps

    Select options for the BuildImageCodePipelineStack.

    -
    interface EmbeddedLinuxCodePipelineBaseImageProps {
        pipelineSourceBucket: IBucket;
        pipelineSourcePrefix?: string;
        pipelineArtifactBucket: Bucket;
        ecrRepository: IRepository;
        encryptionKey: Key;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxCodePipelineBaseImageProps

    Properties

    pipelineSourceBucket +
    interface EmbeddedLinuxCodePipelineBaseImageProps {
        pipelineSourceBucket: IBucket;
        pipelineSourcePrefix?: string;
        pipelineArtifactBucket: Bucket;
        ecrRepository: IRepository;
        encryptionKey: Key;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxCodePipelineBaseImageProps

    Properties

    pipelineSourceBucket pipelineSourcePrefix? pipelineArtifactBucket ecrRepository @@ -16,11 +16,11 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlypipelineSourceBucket

    pipelineSourceBucket: IBucket

    The pipeline source bucket

    -

    OptionalpipelineSourcePrefix

    pipelineSourcePrefix?: string

    The pipeline source prefix

    -

    ReadonlypipelineArtifactBucket

    pipelineArtifactBucket: Bucket

    Artifact bucket to use

    -

    ReadonlyecrRepository

    ecrRepository: IRepository

    The ECR Repository to push to.

    -

    ReadonlyencryptionKey

    encryptionKey: Key

    The encryption key use across

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    OptionalpipelineSourcePrefix

    pipelineSourcePrefix?: string

    The pipeline source prefix

    +

    ReadonlypipelineArtifactBucket

    pipelineArtifactBucket: Bucket

    Artifact bucket to use

    +

    ReadonlyecrRepository

    ecrRepository: IRepository

    The ECR Repository to push to.

    +

    ReadonlyencryptionKey

    encryptionKey: Key

    The encryption key use across

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index b712828..e93c508 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib

    Interface EmbeddedLinuxCodePipelineProps

    Properties to allow customizing the build.

    -
    interface EmbeddedLinuxCodePipelineProps {
        pipelineSourceBucket: IBucket;
        pipelineSourcePrefix?: string;
        pipelineArtifactBucket: Bucket;
        pipelineArtifactPrefix?: string;
        pipelineOutputBucket: Bucket;
        pipelineOutputPrefix?: string;
        ecrRepository: IRepository;
        ecrRepositoryImageTag: string;
        projectType: ProjectType;
        vpc: IVpc;
        buildPolicyAdditions?: PolicyStatement[];
        environmentVariables?: { string: BuildEnvironmentVariable };
        encryptionKey: Key;
        sourceCustomPath?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxCodePipelineProps

    Properties

    pipelineSourceBucket +
    interface EmbeddedLinuxCodePipelineProps {
        pipelineSourceBucket: IBucket;
        pipelineSourcePrefix?: string;
        pipelineArtifactBucket: Bucket;
        pipelineArtifactPrefix?: string;
        pipelineOutputBucket: Bucket;
        pipelineOutputPrefix?: string;
        ecrRepository: IRepository;
        ecrRepositoryImageTag: string;
        projectType: ProjectType;
        vpc: IVpc;
        buildPolicyAdditions?: PolicyStatement[];
        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
        encryptionKey: Key;
        sourceCustomPath?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • EmbeddedLinuxCodePipelineProps

    Properties

    pipelineSourceBucket pipelineSourcePrefix? pipelineArtifactBucket pipelineArtifactPrefix? @@ -25,20 +25,20 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    ReadonlypipelineSourceBucket

    pipelineSourceBucket: IBucket

    The pipeline source bucket

    -

    OptionalpipelineSourcePrefix

    pipelineSourcePrefix?: string

    The pipeline source prefix

    -

    ReadonlypipelineArtifactBucket

    pipelineArtifactBucket: Bucket

    The pipeline artifact bucket to use

    -

    OptionalpipelineArtifactPrefix

    pipelineArtifactPrefix?: string

    The pipeline artifact bucket prefix to use

    -

    ReadonlypipelineOutputBucket

    pipelineOutputBucket: Bucket

    The pipeline output bucket to use

    -

    OptionalpipelineOutputPrefix

    pipelineOutputPrefix?: string

    The pipeline output bucket prefix to use

    -

    ReadonlyecrRepository

    ecrRepository: IRepository

    ECR Repository where the Build Host Image resides.

    -

    ReadonlyecrRepositoryImageTag

    ecrRepositoryImageTag: string

    Tag for the Build Host Image

    -

    ReadonlyprojectType

    projectType: ProjectType

    The type of project being built.

    -

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    -

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    -

    Optional ReadonlyenvironmentVariables

    environmentVariables?: { string: BuildEnvironmentVariable }

    Additional build environment variables to the build project.

    -

    ReadonlyencryptionKey

    encryptionKey: Key

    The encryption key use across

    -

    Optional ReadonlysourceCustomPath

    sourceCustomPath?: string

    Custom asset to be provided when using ProjectType.Custom

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    OptionalpipelineSourcePrefix

    pipelineSourcePrefix?: string

    The pipeline source prefix

    +

    ReadonlypipelineArtifactBucket

    pipelineArtifactBucket: Bucket

    The pipeline artifact bucket to use

    +

    OptionalpipelineArtifactPrefix

    pipelineArtifactPrefix?: string

    The pipeline artifact bucket prefix to use

    +

    ReadonlypipelineOutputBucket

    pipelineOutputBucket: Bucket

    The pipeline output bucket to use

    +

    OptionalpipelineOutputPrefix

    pipelineOutputPrefix?: string

    The pipeline output bucket prefix to use

    +

    ReadonlyecrRepository

    ecrRepository: IRepository

    ECR Repository where the Build Host Image resides.

    +

    ReadonlyecrRepositoryImageTag

    ecrRepositoryImageTag: string

    Tag for the Build Host Image

    +

    ReadonlyprojectType

    projectType: ProjectType

    The type of project being built.

    +

    Readonlyvpc

    vpc: IVpc

    VPC where the networking setup resides.

    +

    Optional ReadonlybuildPolicyAdditions

    buildPolicyAdditions?: PolicyStatement[]

    Additional policy statements to add to the build project.

    +

    Optional ReadonlyenvironmentVariables

    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

    Additional build environment variables to the build project.

    +

    ReadonlyencryptionKey

    encryptionKey: Key

    The encryption key use across

    +

    Optional ReadonlysourceCustomPath

    sourceCustomPath?: string

    Custom asset to be provided when using ProjectType.Custom

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 124a998..b39d2c2 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib

    Interface PipelineResourcesProps

    Select options for the PipelineResourcesStack.

    -
    interface PipelineResourcesProps {
        resource_prefix: string;
        ecrRepositoryName?: string;
        pipelineArtifactBucketName?: string;
        pipelineSourceBucketName?: string;
        pipelineOutputBucketName?: string;
        loggingBucketName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • PipelineResourcesProps

    Properties

    resource_prefix +
    interface PipelineResourcesProps {
        resource_prefix: string;
        ecrRepositoryName?: string;
        pipelineArtifactBucketName?: string;
        pipelineSourceBucketName?: string;
        pipelineOutputBucketName?: string;
        loggingBucketName?: string;
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
    }

    Hierarchy

    • StackProps
      • PipelineResourcesProps

    Properties

    resource_prefix ecrRepositoryName? pipelineArtifactBucketName? pipelineSourceBucketName? @@ -17,12 +17,12 @@ permissionsBoundary? suppressTemplateIndentation?

    Properties

    Readonlyresource_prefix

    resource_prefix: string

    The resource prefix

    -

    Optional ReadonlyecrRepositoryName

    ecrRepositoryName?: string

    The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

    -

    Optional ReadonlypipelineArtifactBucketName

    pipelineArtifactBucketName?: string

    The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

    -

    Optional ReadonlypipelineSourceBucketName

    pipelineSourceBucketName?: string

    The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

    -

    Optional ReadonlypipelineOutputBucketName

    pipelineOutputBucketName?: string

    The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

    -

    Optional ReadonlyloggingBucketName

    loggingBucketName?: string

    Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

    -

    Optional Readonlydescription

    description?: string

    A description of the stack.

    +

    Optional ReadonlyecrRepositoryName

    ecrRepositoryName?: string

    The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

    +

    Optional ReadonlypipelineArtifactBucketName

    pipelineArtifactBucketName?: string

    The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

    +

    Optional ReadonlypipelineSourceBucketName

    pipelineSourceBucketName?: string

    The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

    +

    Optional ReadonlypipelineOutputBucketName

    pipelineOutputBucketName?: string

    The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

    +

    Optional ReadonlyloggingBucketName

    loggingBucketName?: string

    Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

    +

    Optional Readonlydescription

    description?: string

    A description of the stack.

    Default

    - No description.
    diff --git a/modules.html b/modules.html index 1a4e412..1d25f5e 100644 --- a/modules.html +++ b/modules.html @@ -1 +1 @@ -aws4embeddedlinux-cdk-lib

    aws4embeddedlinux-cdk-lib

    Enumerations

    ProjectType

    Classes

    EmbeddedLinuxCodeBuildProjectStack
    EmbeddedLinuxCodePipelineBaseImageStack
    EmbeddedLinuxCodePipelineStack
    PipelineResourcesStack

    Interfaces

    EmbeddedLinuxCodeBuildProjectProps
    EmbeddedLinuxCodePipelineBaseImageProps
    EmbeddedLinuxCodePipelineProps
    PipelineResourcesProps

    Functions

    isBucketVersioned

    Settings

    Member Visibility

    On This Page

    Enumerations
    Classes
    Interfaces
    Functions
    +aws4embeddedlinux-cdk-lib

    aws4embeddedlinux-cdk-lib

    Enumerations

    ProjectType

    Classes

    EmbeddedLinuxCodeBuildProjectStack
    EmbeddedLinuxCodePipelineBaseImageStack
    EmbeddedLinuxCodePipelineStack
    PipelineResourcesStack

    Interfaces

    EmbeddedLinuxCodeBuildProjectProps
    EmbeddedLinuxCodePipelineBaseImageProps
    EmbeddedLinuxCodePipelineProps
    PipelineResourcesProps

    Settings

    Member Visibility

    On This Page

    Enumerations
    Classes
    Interfaces
    From 23643886b2dbda08c6c881d5012c5bc2406f464d Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 15 Apr 2025 13:24:28 +0000 Subject: [PATCH 29/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@6a4b8f759bcabfebadf4786a91?= =?UTF-8?q?5604a3c7024c11=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- assets/main.js | 10 +- assets/search.js | 2 +- assets/style.css | 489 ++++++++++-------- .../EmbeddedLinuxCodeBuildProjectStack.html | 214 ++++---- ...beddedLinuxCodePipelineBaseImageStack.html | 222 ++++---- classes/EmbeddedLinuxCodePipelineStack.html | 214 ++++---- classes/PipelineResourcesStack.html | 242 ++++----- enums/ProjectType.html | 36 +- hierarchy.html | 1 + index.html | 44 +- .../EmbeddedLinuxCodeBuildProjectProps.html | 92 ++-- ...beddedLinuxCodePipelineBaseImageProps.html | 92 ++-- .../EmbeddedLinuxCodePipelineProps.html | 128 ++--- interfaces/PipelineResourcesProps.html | 96 ++-- modules.html | 2 +- 15 files changed, 957 insertions(+), 927 deletions(-) create mode 100644 hierarchy.html diff --git a/assets/main.js b/assets/main.js index 2363f64..3effabb 100644 --- a/assets/main.js +++ b/assets/main.js @@ -1,9 +1,9 @@ "use strict"; -window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse","folder":"Folder","kind_1":"Project","kind_2":"Module","kind_4":"Namespace","kind_8":"Enumeration","kind_16":"Enumeration Member","kind_32":"Variable","kind_64":"Function","kind_128":"Class","kind_256":"Interface","kind_512":"Constructor","kind_1024":"Property","kind_2048":"Method","kind_4096":"Call Signature","kind_8192":"Index Signature","kind_16384":"Constructor Signature","kind_32768":"Parameter","kind_65536":"Type Literal","kind_131072":"Type Parameter","kind_262144":"Accessor","kind_524288":"Get Signature","kind_1048576":"Set Signature","kind_2097152":"Type Alias","kind_4194304":"Reference","kind_8388608":"Document"}; -"use strict";(()=>{var De=Object.create;var le=Object.defineProperty;var Fe=Object.getOwnPropertyDescriptor;var Ne=Object.getOwnPropertyNames;var Ve=Object.getPrototypeOf,Be=Object.prototype.hasOwnProperty;var qe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var je=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ne(e))!Be.call(t,i)&&i!==n&&le(t,i,{get:()=>e[i],enumerable:!(r=Fe(e,i))||r.enumerable});return t};var $e=(t,e,n)=>(n=t!=null?De(Ve(t)):{},je(e||!t||!t.__esModule?le(n,"default",{value:t,enumerable:!0}):n,t));var pe=qe((de,he)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,c],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[c+1]*i[d+1],c+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}s.str.length==1&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),p;m in s.node.edges?p=s.node.edges[m]:(p=new t.TokenSet,s.node.edges[m]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof de=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var ce=[];function G(t,e){ce.push({selector:e,constructor:t})}var J=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){ce.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!ze(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function ze(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var ge=$e(pe(),1);async function A(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}async function fe(t,e){if(!window.searchData)return;let n=await A(window.searchData);t.data=n,t.index=ge.Index.load(n.index),e.classList.remove("loading"),e.classList.add("ready")}function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:document.documentElement.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{fe(e,t)}),fe(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");i.addEventListener("mouseup",()=>{re(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),We(t,i,r,e)}function We(t,e,n,r){n.addEventListener("input",ue(()=>{Ue(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Je(e,t):i.key=="ArrowUp"?(me(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(me(e,n,1),i.preventDefault())}),document.body.addEventListener("keypress",i=>{i.altKey||i.ctrlKey||i.metaKey||!n.matches(":focus")&&i.key==="/"&&(i.preventDefault(),n.focus())}),document.body.addEventListener("keyup",i=>{t.classList.contains("has-focus")&&(i.key==="Escape"||!e.matches(":focus-within")&&!n.matches(":focus"))&&(n.blur(),re(t))})}function re(t){t.classList.remove("has-focus")}function Ue(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ye(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` - ${ye(l.parent,i)}.${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=c+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function me(t,e,n){let r=t.querySelector(".current");if(!r)r=t.querySelector(n==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let i=r;if(n===1)do i=i.nextElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);else do i=i.previousElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);i?(r.classList.remove("current"),i.classList.add("current")):n===-1&&(r.classList.remove("current"),e.focus())}}function Je(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),re(e)}}function ye(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ne(t.substring(s,o)),`${ne(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ne(t.substring(s))),i.join("")}var Ge={"&":"&","<":"<",">":">","'":"'",'"':"""};function ne(t){return t.replace(/[&<>"'"]/g,e=>Ge[e])}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var H="mousedown",Ee="mousemove",B="mouseup",X={x:0,y:0},xe=!1,ie=!1,Xe=!1,D=!1,be=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(be?"is-mobile":"not-mobile");be&&"ontouchstart"in document.documentElement&&(Xe=!0,H="touchstart",Ee="touchmove",B="touchend");document.addEventListener(H,t=>{ie=!0,D=!1;let e=H=="touchstart"?t.targetTouches[0]:t;X.y=e.pageY||0,X.x=e.pageX||0});document.addEventListener(Ee,t=>{if(ie&&!D){let e=H=="touchstart"?t.targetTouches[0]:t,n=X.x-(e.pageX||0),r=X.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ie=!1});document.addEventListener("click",t=>{xe&&(t.preventDefault(),t.stopImmediatePropagation(),xe=!1)});var Y=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(H,n=>this.onDocumentPointerDown(n)),document.addEventListener(B,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var se;try{se=localStorage}catch{se={getItem(){return null},setItem(){}}}var C=se;var Le=document.head.appendChild(document.createElement("style"));Le.dataset.for="filters";var Z=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),Le.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=C.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){C.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var oe=new Map,ae=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;C.setItem(this.key,e.toString())}},K=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(oe.has(i))s=oe.get(i);else{let o=C.getItem(i),a=o?o==="true":this.el.open;s=new ae(i,a),oe.set(i,s)}s.add(this.el)}};function Se(t){let e=C.getItem("tsd-theme")||"os";t.value=e,we(e),t.addEventListener("change",()=>{C.setItem("tsd-theme",t.value),we(t.value)})}function we(t){document.documentElement.dataset.theme=t}var ee;function Ce(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Te),Te())}async function Te(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await A(window.navigationData);ee=document.documentElement.dataset.base,ee.endsWith("/")||(ee+="/"),t.innerHTML="";for(let n of e)Ie(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ie(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',ke(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let c of t.children)Ie(c,l,i)}else ke(t,r,t.class)}function ke(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=ee+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&r.classList.add("current"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(document.createElement("span")).textContent=t.text}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(document.createElement("span")).textContent=t.text}}var te=document.documentElement.dataset.base;te.endsWith("/")||(te+="/");function Pe(){document.querySelector(".tsd-full-hierarchy")?Ye():document.querySelector(".tsd-hierarchy")&&Ze()}function Ye(){document.addEventListener("click",r=>{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=tt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function Ze(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Qe),Qe())}async function Qe(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await A(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),Ke(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function Ke(t,e,n){let r=e.roots.filter(i=>et(e,i,n));for(let i of r)t.appendChild(_e(e,i,n))}function _e(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let l=t.reflections[a],c=s.appendChild(document.createElement("a"));c.textContent=l.name,c.href=te+l.url,c.className=l.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=te+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let l=_e(t,a,n,r);l&&o.appendChild(l)}}return r.delete(e),s}function et(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function tt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.setAttribute("viewBox","0 0 24 24"),t.setAttribute("fill","none"),t.innerHTML='',t}G(Y,"a[data-toggle]");G(K,".tsd-accordion");G(Z,".tsd-filter-item input[type=checkbox]");var Oe=document.getElementById("tsd-theme");Oe&&Se(Oe);var nt=new J;Object.defineProperty(window,"app",{value:nt});ve();Ce();Pe();})(); +window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse","folder":"Folder","search_index_not_available":"The search index is not available","search_no_results_found_for_0":"No results found for {0}","kind_1":"Project","kind_2":"Module","kind_4":"Namespace","kind_8":"Enumeration","kind_16":"Enumeration Member","kind_32":"Variable","kind_64":"Function","kind_128":"Class","kind_256":"Interface","kind_512":"Constructor","kind_1024":"Property","kind_2048":"Method","kind_4096":"Call Signature","kind_8192":"Index Signature","kind_16384":"Constructor Signature","kind_32768":"Parameter","kind_65536":"Type Literal","kind_131072":"Type Parameter","kind_262144":"Accessor","kind_524288":"Get Signature","kind_1048576":"Set Signature","kind_2097152":"Type Alias","kind_4194304":"Reference","kind_8388608":"Document"}; +"use strict";(()=>{var Je=Object.create;var he=Object.defineProperty;var Ke=Object.getOwnPropertyDescriptor;var Ge=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var Ze=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var et=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ge(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ke(e,i))||r.enumerable});return t};var tt=(t,e,n)=>(n=t!=null?Je(Xe(t)):{},et(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=Ze((me,ge)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,l],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(oc?d+=2:a==c&&(n+=r[l+1]*i[d+1],l+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),c=0;c1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof me=="object"?ge.exports=n():e.lunr=n()}(this,function(){return t})})()});var O,G={getItem(){return null},setItem(){}},K;try{K=localStorage,O=K}catch{K=G,O=G}var S={getItem:t=>O.getItem(t),setItem:(t,e)=>O.setItem(t,e),disableWritingLocalStorage(){O=G},disable(){localStorage.clear(),O=G},enable(){O=K}};window.TypeDoc||={disableWritingLocalStorage(){S.disableWritingLocalStorage()},disableLocalStorage:()=>{S.disable()},enableLocalStorage:()=>{S.enable()}};window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",search_index_not_available:"The search index is not available",search_no_results_found_for_0:"No results found for {0}",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var pe=[];function Y(t,e){pe.push({selector:e,constructor:t})}var X=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){pe.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!nt(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function nt(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var fe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var Ie=tt(ye(),1);async function R(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}var Z="closing",ae="tsd-overlay";function rt(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function it(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function xe(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Z)&&(t.classList.remove(Z),document.getElementById(ae)?.remove(),t.close(),it())}),t.addEventListener("cancel",n=>{n.preventDefault(),ve(t)}),e?.closeOnClick&&document.addEventListener("click",n=>{t.open&&!t.contains(n.target)&&ve(t)},!0)}function Ee(t){if(t.open)return;let e=document.createElement("div");e.id=ae,document.body.appendChild(e),t.showModal(),rt()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Z),t.classList.add(Z)}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var le={};function we(t){for(let e of t.split(/\s+/))if(le.hasOwnProperty(e)&&!le[e])return!0;return!1}var ee=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=S.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){S.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),le[`tsd-is-${this.el.name}`]=this.value,this.app.filterChanged(),this.app.updateIndexVisibility()}};var Le=0;async function Se(t,e){if(!window.searchData)return;let n=await R(window.searchData);t.data=n,t.index=Ie.Index.load(n.index),e.innerHTML=""}function _e(){let t=document.getElementById("tsd-search-trigger"),e=document.getElementById("tsd-search"),n=document.getElementById("tsd-search-input"),r=document.getElementById("tsd-search-results"),i=document.getElementById("tsd-search-script"),s=document.getElementById("tsd-search-status");if(!(t&&e&&n&&r&&i&&s))throw new Error("Search controls missing");let o={base:document.documentElement.dataset.base};o.base.endsWith("/")||(o.base+="/"),i.addEventListener("error",()=>{let a=window.translations.search_index_not_available;Pe(s,a)}),i.addEventListener("load",()=>{Se(o,s)}),Se(o,s),st({trigger:t,searchEl:e,results:r,field:n,status:s},o)}function st(t,e){let{field:n,results:r,searchEl:i,status:s,trigger:o}=t;xe(i,{closeOnClick:!0});function a(){Ee(i),n.setSelectionRange(0,n.value.length)}o.addEventListener("click",a),n.addEventListener("input",fe(()=>{ot(r,n,s,e)},200)),n.addEventListener("keydown",l=>{if(r.childElementCount===0||l.ctrlKey||l.metaKey||l.altKey)return;let d=n.getAttribute("aria-activedescendant"),f=d?document.getElementById(d):null;if(f){let p=!1,v=!1;switch(l.key){case"Home":case"End":case"ArrowLeft":case"ArrowRight":v=!0;break;case"ArrowDown":case"ArrowUp":p=l.shiftKey;break}(p||v)&&ke(n)}if(!l.shiftKey)switch(l.key){case"Enter":f?.querySelector("a")?.click();break;case"ArrowUp":Te(r,n,f,-1),l.preventDefault();break;case"ArrowDown":Te(r,n,f,1),l.preventDefault();break}});function c(){ke(n)}n.addEventListener("change",c),n.addEventListener("blur",c),n.addEventListener("click",c),document.body.addEventListener("keydown",l=>{if(l.altKey||l.metaKey||l.shiftKey)return;let d=l.ctrlKey&&l.key==="k",f=!l.ctrlKey&&!ct()&&l.key==="/";(d||f)&&(l.preventDefault(),a())})}function ot(t,e,n,r){if(!r.index||!r.data)return;t.innerHTML="",n.innerHTML="",Le+=1;let i=e.value.trim(),s;if(i){let a=i.split(" ").map(c=>c.length?`*${c}*`:"").join(" ");s=r.index.search(a).filter(({ref:c})=>{let l=r.data.rows[Number(c)].classes;return!l||!we(l)})}else s=[];if(s.length===0&&i){let a=window.translations.search_no_results_found_for_0.replace("{0}",` "${te(i)}" `);Pe(n,a);return}for(let a=0;ac.score-a.score);let o=Math.min(10,s.length);for(let a=0;a`,f=Ce(c.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(f+=` (score: ${s[a].score.toFixed(2)})`),c.parent&&(f=` + ${Ce(c.parent,i)}.${f}`);let p=document.createElement("li");p.id=`tsd-search:${Le}-${a}`,p.role="option",p.ariaSelected="false",p.classList.value=c.classes??"";let v=document.createElement("a");v.tabIndex=-1,v.href=r.base+c.url,v.innerHTML=d+`${f}`,p.append(v),t.appendChild(p)}}function Te(t,e,n,r){let i;if(r===1?i=n?.nextElementSibling||t.firstElementChild:i=n?.previousElementSibling||t.lastElementChild,i!==n){if(!i||i.role!=="option"){console.error("Option missing");return}i.ariaSelected="true",i.scrollIntoView({behavior:"smooth",block:"nearest"}),e.setAttribute("aria-activedescendant",i.id),n?.setAttribute("aria-selected","false")}}function ke(t){let e=t.getAttribute("aria-activedescendant");(e?document.getElementById(e):null)?.setAttribute("aria-selected","false"),t.setAttribute("aria-activedescendant","")}function Ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(te(t.substring(s,o)),`${te(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(te(t.substring(s))),i.join("")}var at={"&":"&","<":"<",">":">","'":"'",'"':"""};function te(t){return t.replace(/[&<>"'"]/g,e=>at[e])}function Pe(t,e){t.innerHTML=e?`
    ${e}
    `:""}var lt=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ct(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!lt.includes(t.type):!1}var D="mousedown",Oe="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,ut=!1,F=!1,Me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Me?"is-mobile":"not-mobile");Me&&"ontouchstart"in document.documentElement&&(ut=!0,D="touchstart",Oe="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Oe,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Fe(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Ne(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ne(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Ne(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(document.createElement("span")).textContent=t.text}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(document.createElement("span")).textContent=t.text}}var oe=document.documentElement.dataset.base;oe.endsWith("/")||(oe+="/");function Ve(){document.querySelector(".tsd-full-hierarchy")?dt():document.querySelector(".tsd-hierarchy")&&ht()}function dt(){document.addEventListener("click",r=>{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=mt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function ht(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Be),Be())}async function Be(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await R(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),pt(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function pt(t,e,n){let r=e.roots.filter(i=>ft(e,i,n));for(let i of r)t.appendChild($e(e,i,n))}function $e(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let c=t.reflections[a],l=s.appendChild(document.createElement("a"));l.textContent=c.name,l.href=oe+c.url,l.className=c.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=oe+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let c=$e(t,a,n,r);c&&o.appendChild(c)}}return r.delete(e),s}function ft(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function mt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.setAttribute("viewBox","0 0 24 24"),t.setAttribute("fill","none"),t.innerHTML='',t}Y(re,"a[data-toggle]");Y(ie,".tsd-accordion");Y(ee,".tsd-filter-item input[type=checkbox]");var je=document.getElementById("tsd-theme");je&&He(je);var gt=new X;Object.defineProperty(window,"app",{value:gt});_e();Fe();Ve();"virtualKeyboard"in navigator&&(navigator.virtualKeyboard.overlaysContent=!0);})(); /*! Bundled license information: lunr/lunr.js: diff --git a/assets/search.js b/assets/search.js index 0144565..f18c064 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "eJy9m0tv2zgQx78LcxVS8yU/bu2ih6KLbrYtejGCQpGZVBtb0kpyNkGQ776gHtbQQ8mULPfkwOHM/En+OBxS8ivJkv9yslq/ksco3pDVwiNxsFNkRW6y5B8VFt9fUkU8ss+2ZEVUvN/l78B/rn8Vuy3xSLgN8lzlZEXIm9f4on7rLHl8OeHlKq3aAFceSYNMxcWRGmuEvz/u9qci/KvKNiMj6D6830Uu3QjKZiPjfA7yUzEeyyYj/X9VscpPx8gOzUbG+fKcfto9nwoTP6dR2WpklD+Sjfqwj7abU4HCZKPu6oZjY+3zItmdDNS0GhKFyTbMx92d2mzU5s8o3j8f+lfb3WRJ2s5dFBcquw9Clb87bdW/WGdMHBSoMPuq0iSPiiR7OSPYlQqzDDqyD4lDh12EftoFD+p78DCZ4Eg7LEqHUwt/SsNzZFbmU4sql8dNso3Cl/ebTVRESXwOalelv7T0FwB/k0MQh9lLqr1/VufRenD0qKailS3c1vW3IggfD+LryP3KS5PeRS0pO0QPkzgvsn1YJNnYMFemjxHDU/XSMe3dRKnaRrH6EOSqXNvuuc9u6p4A09r+W7LPQvVhHz6q4tzAV43TvHR61zh1HMaO0XDqwE2m7qPniTuQNk4v2oH3WRHdB2Ex8RwEtdvLzsLwfbRP+8jNdKDkwcm0V/K4jHpacl9aRdaOudVud5kE2xNrXJbt6PQgMEepnYpKd72ozjtf9/BK76R+p61t+I72uzeyyfevy25bk+9Wl96kLrA3DZI8zRg3ki86yn/ti3Q/0Rgnpa+LjnAld5rxreReZHTH1yjTlSYXOuOfEjo+6/cDYLk5HTrvlYuicjGlONeLB4uoQZcOTmJGXzhY1J132eBGYvwUZUm8U3HxI8ii4G6rRssFvp6Ar2nlji3lp6vgewVWO3N1q3oTFL/Gaqz8VPeuaeXnXJku54uBx4rfcJqY6hDRV8s2bb7WhVXeWcPaW7rXrllt9zPt3EN7Qlxh844LeXuHXHajL/q7gbKMHSiuHEwhzF6LjlFor0MvIBUeSs4RCg8kF5AJ685zZMKac0KZ2+ThIYofxuurHUwiDORN1NieL+3NJsmTPa6d8mNHDxwqKxcFfeXUsMj9tzl9Gtzq9mFqThyKXWQNPAmP02e9EhmizukeZJw261F3iDan8+0wbUaeGSTKSDBTMW8tbp2Yd6pou9TceiSKN+qZrF7Jk8ryKInJirBrfr0kHrmP1Haj36chTR5NdrrEJx7ZJOG+/PO2bvZD6eSjG1et382It555nF4vhX97660b4/If5ReNj/ab0pASb009Pr+eSWEYUmRIDUNGvDWzGTJkyAxDTrw1txlyZMgNQ0G8tbAZCmQoDENJvLW0GUpkKA1Dn3hr32boI0PfMJwTbz23Gc6R4dwwXBBvvbAZLpDhwjBcEm+9tBkukeHSBEDzQGceE9czn5oIYHjoET0lPtRji2u5ODK2AGQSRDUXlFmNMUTUpIhqNii3IU8xSNQkiWo+qPCYfz3zF6YxhomaNFHNCLXyRDFQ1CSKak6ob42MoaImVVSzQq1cUQwWNcmimhe6sI42houadFHNDF1aRxsDRk3CmGaGzWyRGSaMmYQx2oknw4SxoxzFOueZWdKUSRjTzDBrbmSYMGYSxkTnPDNMGDMJY7K7z5gwZhLG/M4lyTBhzCSMaWaYPa1jwphJGOsmjGHCmEkY6yaMYcKYSRjvJoxjwrhJGNfMMPuOhAnjJmG83AaFTTbHhPGjnbAkzJpJuGUzNAnjohMSjgnjJmFcdkLCMWHcJIz7XcUGx4BxEzA+78z5HAPGTcD4ojPncwwYNwHjGhlm3c05BoybgIlZZyIRGDBhAiZKwKxpW2DAhAmYKAGzlgQCAyZMwATvzEICAyaOyi2NDLPWFMJScZmACY0Mn1mNMWDCBExoZrg18wpMmDAJE5oZbk1hAhMmTMKEZoZbc4HAhAmTMKGZ4fYKFRMmTMKkZobbq1RMmDQJk5oZbmVbYsKkSZhknZBITJg0CZO8cz1LTJg0CZPdKUxiwuRRUS87c7601PUmYdLv3KokJkyahMl5Z86XmDBpEiZLwqzJQGLCpEmYXHamIYkJq78qT51PKivU5lN1+lyvif2J1yv5WR9QKW9Oy6+EcrJ6ffMIX+jPt/ZgWn57OJvq/1WKDi/Lt/7mrbu5oxdwxwZ0+UCXX9kyUX2KWqdkbhHqd+1b54vWt1tXj67AgMwZkDmrZdL6U9bDWcuWYnis9ukziElBzCZWPURcDo9R3UK0/jnwL3w3f/VDoq1+SHTgon5AnVbPftoAy9b/8nz3eXVjDMZHgvFxHI/jAM0V2V2Qq3IOUCcoIJ26oX46CuoLA3PB+HlRUBcYA87P7AJWDhaZcFuoR5duYKwFGOt6NTFWJ4N61UlHlKyP1IFskHe4m8vyh1atB6DVbcEf3XyChQgQk26JyvKYBvgDC0POnPw1v7xqnYDxccsNXff0YMxBEmX1dPJmWt0WcN/jSDAAAHjhBnzXy2tAPdhBOR3k1LyABy4BQ7zmXA7Ti58jgmGAiLoxbn/HDCgGaHG3PNW4bB7B5zg/gY1CuK0l5BTlJQ4AlsOmy3yWA9ITSHV0Uaen+lMOWyT4KTVQDkATbunA/norUA5GmC5r5Y5ElL/EBa6AJ2cH5W9gQQ8BRG4+4CtwrR+QT5p04jYN1Y9/AYEgMTk5OPwgtvUBk66jj6N3UsAAgZ4JN2/4vSfQPbDBCLdZKx9Ig1kHI0TrTMXnNfoOc3jrHRglq/Xt29v/wSkIxg=="; \ No newline at end of file +window.searchData = "eJy9mktv2zgQx78LcxVS8+XXrS16KLroZtuiFyMoFJlJtbElrSRnEwT57gu9rKGHlChZ3pOLVDPz5/DH4VDUK0njfzOy3rySxzDakjWTc49E/l6RNfm0v1Pbrdr+EUaH54/xVn04hLvtTRr/rYL8Jo2TjHjkkO7ImoRRrtJ7P1DZu36r69/5fkc8Euz8LFMZWRPy5jUC6IyJowIVpN9UEmdhHqcvZwS7UkGaQkcgtEcSP1VR7jZgF6Gf9/6D+uE/TCY4LBzmpcOphT8lwTkyK/OpRd2VD8a7MHh5v92GeRhH56B2VfpLSn8+8Dc5BFGQviSF9y/qPFqPjh7VVLSypdu6/p77weNRfB25W3lp0rmoJWXH6EEcZXl6CPI4HRvmSvcxIj3VKFuBnWXvJkzULozUBz9T5dp2r31mU/cCmNT23+NDGqgPh+BR5ecGvmqcZqXTu8apYxot2XAawE2q7sPniQeQNE4vOoD3aR7e+0E+8Rz4tdvLzsLwfbRL+8jNdKDkwcW0U/K4itovuausImvH2mq2O7drGhNusqk+rbcDmqfzdQ9vn3r1j97QukSP2tV6pTptbcN3tP97I5t8/7rstjX5bnXpTeoCe9MgydPkuJF80Sz/eciTw0Q5jktfF81wJXea/FZyL5Ld8T3KdK3Jhc74fULHb1DdAFRnnR8viRo975WLvHIxpTjXFw8GUYNeOjiJGf3CwaDuvJcNbiRGT2EaR3sV5T/9NPTvdmq0XODrCfiaVu7YVn66Dr5TYLUzfzxkeby/8fPfYzVWfoLST1L5OVemy/li4LHigq9rcIjzmtquXrZ55lvdWGXWHtb8pHvvmtZ2vxLrHtoR4gqbm7NgGZDLbvS1+NtAWdoOFFUOphBm7kXHKDT3oReQCg8l5wiFB5ILyIR95zkyYc85ocxd/PAQRg/j9dUOJhEG6iZ62FwvzY+5VwnY0Dj47OxiLJJHve/p0uDWLg9T03MWdZE18AA6Tp/xTcQQdU6vH8ZpM54wh2hzOlYO06Yt70GitHU9FfPGntKJeadGsleNa4/UJcWlN+oVAgqd4bynosM+ewf+p7uggfYqfnzp8XKVVM9YhAM1xgh/fdof+iL8o8pnRkYoxvB+H7oMwy8fGxnni5/1xXj07aeqXv/fVKSy/hjp8bGRcb4+J5/3z31houck3He0sX1RjnexfYGCeKvu6gfHxirPYr2Bmqccotx6JIy26pmsX8mTSrMwjsiasGt+vSIeuQ/Vblt8T0Oa/iXeF0dr4pFtHBzKf97Wj/1UxcIvHq6efjcj3mbm8cX1TIrbW2/TGJf/Uf6h8dH+pTSkxNtQj4nr2ZxqhhQZUs2QEW/DPLa8lkvdkCFDphly4m24yZAjQ64ZCuJthMfp9UrMNUOBDIVmKIm3kR6bX8/mS81QIkOpGc6Jt5mbsjpHhnPNcEG8zcIUcYEMF5rhknibpSniEhkuNcMV8TYrU1ZXyHClA1DwQGemvFIMDz2hp8SHmuJSA0A6QZRZ2cMMUR0iym1zSjFGVOeIFnRQZsoyxShRnSUqraIxTVTHic5ta4ZioKhOFLUiRTFTVIeKFqhQbhww5orqYFErWRSjRXW2mJ0thtliOlvMzhbDbLGT6lSyJUxDZoYCpcPFCl6oNMrGdDGdLlbSZawaDNPFdLqYlS6G6WI6XcxKF8N0MZ0uVgBDF8YRY7yYjhdb2io6w3QxnS62shV1huliOl28pMtYLTmmi+t0cWorIBzDxXW4eAnXyhgYw8VPtr8CF2bcq7lhB9Th4sJWBThmi+ts8QIXRo2BMVxch4uXcBlrJsd0cZ0uXvDCjPWHY7q4ThcvgGHGlcwxXlzHixfEMGk0xnxxnS9REMOMK1lgvoTOlyiQYQujMQZM6ICJsrkyki0wYEIHTFgbLIH5EictlrDVH2FosnS+hLTWa4H5EjpfYm7bZQTGS+h4iYW1XAuMl9DxEiVexrUsMF5Cx0usbEVEYLqETpec2ZayxHBJHS5JreVaYrikDpcscOHGAiQxXFKHS5ZwGYuIxHRJnS5ZAMONRURivORJE18Aw41FRBr6eB0vWRDDjUVEYr6kzpcsiOHGIiIxX1LnS5abo7GISMyX1PmSBTLcWEQkBqz+U3nKfFJprrafq9PmZkPMN8uv5Fd9ID2+HXslgqxf3zzCVsXvW3sMLf96PIkW/1fpOR60W2983rqTS0c/4H1W62nROlpUlrT+5bVOOXPzX5/TgUjgW7oN9uSdd+uLtq5oLZPVv7JOZ/0rxPBI7TcebUTWRmwizetI8+ERqjcOwDtv3fOFm7/6InZXXMQeqag/Akmq+9U2wKz17zZ/ne6z6lamdQ/4c8zGqfvmbfidn6ky/2gIyzaGG+L9MdA4KJhm6kiOLQoaAAWTTM8cAlLOwAxz7uZcf7ve+pJgodas87oI1KtNOK5f4wcrICNgTrkbl+XLWVBUQE6ldPJwcsUBUrgCRdltfgzXoMAfKHiCOvlr3teCAcLJcKsMtis5kHdYP+spZc3UumWx68IfpADsc9wtpbbPQ4F64JSxQU71uzbgEmSZ1ayLYdnGN/UgDaA+CjfOzV9xAsXAJXOrVI3L5iOXDFUoBrjgwzg4OsWVCSxyMWy69Gvb1iVYqKu6QNW/wm37sX8FAnQDJrhbvTN/Pg4mDRRpOqvXnSMP5f0dqAvAlXTManN3BryA/U46UgQ/MwVDA8WO1S2jdCt61cUhEAUolG5b2fE6DXgBVUK6UYG+/gIwgERxN2/4C0OQLUAwd5u98hsUMDzgoAZpWS8Bh5TdekdWyXpz+/b2H/bEBcU="; \ No newline at end of file diff --git a/assets/style.css b/assets/style.css index 2ab8b83..7c3fbdb 100644 --- a/assets/style.css +++ b/assets/style.css @@ -1,14 +1,33 @@ @layer typedoc { + :root { + --dim-toolbar-contents-height: 2.5rem; + --dim-toolbar-border-bottom-width: 1px; + --dim-header-height: calc( + var(--dim-toolbar-border-bottom-width) + + var(--dim-toolbar-contents-height) + ); + + /* 0rem For mobile; unit is required for calculation in `calc` */ + --dim-container-main-margin-y: 0rem; + + --dim-footer-height: 3.5rem; + + --modal-animation-duration: 0.2s; + } + :root { /* Light */ --light-color-background: #f2f4f8; --light-color-background-secondary: #eff0f1; - --light-color-warning-text: #222; + /* Not to be confused with [:active](https://developer.mozilla.org/en-US/docs/Web/CSS/:active) */ + --light-color-background-active: #d6d8da; --light-color-background-warning: #e6e600; + --light-color-warning-text: #222; --light-color-accent: #c5c7c9; - --light-color-active-menu-item: var(--light-color-accent); + --light-color-active-menu-item: var(--light-color-background-active); --light-color-text: #222; - --light-color-text-aside: #6e6e6e; + --light-color-contrast-text: #000; + --light-color-text-aside: #5e5e5e; --light-color-icon-background: var(--light-color-background); --light-color-icon-text: var(--light-color-text); @@ -56,15 +75,20 @@ --light-external-icon: url("data:image/svg+xml;utf8,"); --light-color-scheme: light; + } + :root { /* Dark */ --dark-color-background: #2b2e33; --dark-color-background-secondary: #1e2024; + /* Not to be confused with [:active](https://developer.mozilla.org/en-US/docs/Web/CSS/:active) */ + --dark-color-background-active: #5d5d6a; --dark-color-background-warning: #bebe00; --dark-color-warning-text: #222; --dark-color-accent: #9096a2; - --dark-color-active-menu-item: #5d5d6a; + --dark-color-active-menu-item: var(--dark-color-background-active); --dark-color-text: #f5f5f5; + --dark-color-contrast-text: #ffffff; --dark-color-text-aside: #dddddd; --dark-color-icon-background: var(--dark-color-background-secondary); @@ -119,11 +143,13 @@ --color-background-secondary: var( --light-color-background-secondary ); + --color-background-active: var(--light-color-background-active); --color-background-warning: var(--light-color-background-warning); --color-warning-text: var(--light-color-warning-text); --color-accent: var(--light-color-accent); --color-active-menu-item: var(--light-color-active-menu-item); --color-text: var(--light-color-text); + --color-contrast-text: var(--light-color-contrast-text); --color-text-aside: var(--light-color-text-aside); --color-icon-background: var(--light-color-icon-background); @@ -179,11 +205,13 @@ --color-background-secondary: var( --dark-color-background-secondary ); + --color-background-active: var(--dark-color-background-active); --color-background-warning: var(--dark-color-background-warning); --color-warning-text: var(--dark-color-warning-text); --color-accent: var(--dark-color-accent); --color-active-menu-item: var(--dark-color-active-menu-item); --color-text: var(--dark-color-text); + --color-contrast-text: var(--dark-color-contrast-text); --color-text-aside: var(--dark-color-text-aside); --color-icon-background: var(--dark-color-icon-background); @@ -233,23 +261,17 @@ } } - html { - color-scheme: var(--color-scheme); - } - - body { - margin: 0; - } - :root[data-theme="light"] { --color-background: var(--light-color-background); --color-background-secondary: var(--light-color-background-secondary); + --color-background-active: var(--light-color-background-active); --color-background-warning: var(--light-color-background-warning); --color-warning-text: var(--light-color-warning-text); --color-icon-background: var(--light-color-icon-background); --color-accent: var(--light-color-accent); --color-active-menu-item: var(--light-color-active-menu-item); --color-text: var(--light-color-text); + --color-contrast-text: var(--light-color-contrast-text); --color-text-aside: var(--light-color-text-aside); --color-icon-text: var(--light-color-icon-text); @@ -299,12 +321,14 @@ :root[data-theme="dark"] { --color-background: var(--dark-color-background); --color-background-secondary: var(--dark-color-background-secondary); + --color-background-active: var(--dark-color-background-active); --color-background-warning: var(--dark-color-background-warning); --color-warning-text: var(--dark-color-warning-text); --color-icon-background: var(--dark-color-icon-background); --color-accent: var(--dark-color-accent); --color-active-menu-item: var(--dark-color-active-menu-item); --color-text: var(--dark-color-text); + --color-contrast-text: var(--dark-color-contrast-text); --color-text-aside: var(--dark-color-text-aside); --color-icon-text: var(--dark-color-icon-text); @@ -351,6 +375,13 @@ --color-scheme: var(--dark-color-scheme); } + html { + color-scheme: var(--color-scheme); + @media (prefers-reduced-motion: no-preference) { + scroll-behavior: smooth; + } + } + *:focus-visible, .tsd-accordion-summary:focus-visible svg { outline: 2px solid var(--color-focus-outline); @@ -421,16 +452,19 @@ border-top: 1px solid var(--color-accent); padding-top: 1rem; padding-bottom: 1rem; - max-height: 3.5rem; + max-height: var(--dim-footer-height); } footer > p { margin: 0 1em; } .container-main { - margin: 0 auto; + margin: var(--dim-container-main-margin-y) auto; /* toolbar, footer, margin */ - min-height: calc(100vh - 41px - 56px - 4rem); + min-height: calc( + 100svh - var(--dim-header-height) - var(--dim-footer-height) - + 2 * var(--dim-container-main-margin-y) + ); } @keyframes fade-in { @@ -450,29 +484,6 @@ opacity: 0; } } - @keyframes fade-in-delayed { - 0% { - opacity: 0; - } - 33% { - opacity: 0; - } - 100% { - opacity: 1; - } - } - @keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; - } - 66% { - opacity: 0; - } - 100% { - opacity: 0; - } - } @keyframes pop-in-from-right { from { transform: translate(100%, 0); @@ -492,10 +503,19 @@ } body { background: var(--color-background); - font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", - Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-family: + -apple-system, + BlinkMacSystemFont, + "Segoe UI", + "Noto Sans", + Helvetica, + Arial, + sans-serif, + "Apple Color Emoji", + "Segoe UI Emoji"; font-size: 16px; color: var(--color-text); + margin: 0; } a { @@ -514,6 +534,9 @@ a.tsd-anchor-link { color: var(--color-text); } + :target { + scroll-margin-block: calc(var(--dim-header-height) + 0.5rem); + } code, pre { @@ -545,7 +568,8 @@ box-sizing: border-box; } pre:hover > button, - pre > button.visible { + pre > button.visible, + pre > button:focus-visible { opacity: 1; } @@ -555,6 +579,52 @@ border-left: 4px solid gray; } + img { + max-width: 100%; + } + + * { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); + } + + *::-webkit-scrollbar { + width: 0.75rem; + } + + *::-webkit-scrollbar-track { + background: var(--color-icon-background); + } + + *::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); + } + + dialog { + border: none; + outline: none; + padding: 0; + background-color: var(--color-background); + } + dialog::backdrop { + display: none; + } + #tsd-overlay { + background-color: rgba(0, 0, 0, 0.5); + position: fixed; + z-index: 9999; + top: 0; + left: 0; + right: 0; + bottom: 0; + animation: fade-in var(--modal-animation-duration) forwards; + } + #tsd-overlay.closing { + animation-name: fade-out; + } + .tsd-typography { line-height: 1.333em; } @@ -629,6 +699,7 @@ .tsd-breadcrumb { margin: 0; + margin-top: 1rem; padding: 0; color: var(--color-text-aside); } @@ -733,7 +804,7 @@ margin-right: 0.5em; border-radius: 0.33em; /* Leaving this at full opacity breaks event listeners on Firefox. - Don't remove unless you know what you're doing. */ + Don't remove unless you know what you're doing. */ opacity: 0.99; } .tsd-filter-input input[type="checkbox"]:focus-visible + svg { @@ -876,7 +947,8 @@ } .tsd-navigation.settings { - margin: 1rem 0; + margin: 0; + margin-bottom: 1rem; } .tsd-navigation > a, .tsd-navigation .tsd-accordion-summary { @@ -898,6 +970,7 @@ .tsd-navigation a.current, .tsd-page-navigation a.current { background: var(--color-active-menu-item); + color: var(--color-contrast-text); } .tsd-navigation a:hover, .tsd-page-navigation a:hover { @@ -931,14 +1004,14 @@ margin-left: -1.5rem; } - .tsd-page-navigation-section { - margin-left: 10px; - } .tsd-page-navigation-section > summary { padding: 0.25rem; } + .tsd-page-navigation-section > summary > svg { + margin-right: 0.25rem; + } .tsd-page-navigation-section > div { - margin-left: 20px; + margin-left: 30px; } .tsd-page-navigation ul { padding-left: 1.75rem; @@ -964,6 +1037,10 @@ .tsd-accordion-summary { list-style-type: none; /* hide marker on non-safari */ outline: none; /* broken on safari, so just hide it */ + display: flex; + align-items: center; + gap: 0.25rem; + box-sizing: border-box; } .tsd-accordion-summary::-webkit-details-marker { display: none; /* hide marker on safari */ @@ -986,28 +1063,21 @@ padding-top: 0; padding-bottom: 0; } - .tsd-accordion .tsd-accordion-summary > svg { - margin-left: 0.25rem; - vertical-align: text-top; - } /* * We need to be careful to target the arrow indicating whether the accordion * is open, but not any other SVGs included in the details element. */ - .tsd-accordion:not([open]) > .tsd-accordion-summary > svg:first-child, - .tsd-accordion:not([open]) > .tsd-accordion-summary > h1 > svg:first-child, - .tsd-accordion:not([open]) > .tsd-accordion-summary > h2 > svg:first-child, - .tsd-accordion:not([open]) > .tsd-accordion-summary > h3 > svg:first-child, - .tsd-accordion:not([open]) > .tsd-accordion-summary > h4 > svg:first-child, - .tsd-accordion:not([open]) > .tsd-accordion-summary > h5 > svg:first-child { + .tsd-accordion:not([open]) > .tsd-accordion-summary > svg:first-child { transform: rotate(-90deg); } .tsd-index-content > :not(:first-child) { margin-top: 0.75rem; } - .tsd-index-heading { + .tsd-index-summary { margin-top: 1.5rem; margin-bottom: 0.75rem; + display: flex; + align-content: center; } .tsd-no-select { @@ -1062,117 +1132,104 @@ margin-bottom: 1rem; } - #tsd-search { - transition: background-color 0.2s; + #tsd-search[open] { + animation: fade-in var(--modal-animation-duration) ease-out forwards; } - #tsd-search .title { - position: relative; - z-index: 2; + #tsd-search[open].closing { + animation-name: fade-out; } - #tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 2.5rem; - height: 100%; - } - #tsd-search .field input { + + /* Avoid setting `display` on closed dialog */ + #tsd-search[open] { + display: flex; + flex-direction: column; + padding: 1rem; + width: 32rem; + max-width: 90vw; + max-height: calc(100vh - env(keyboard-inset-height, 0px) - 25vh); + /* Anchor dialog to top */ + margin-top: 10vh; + border-radius: 6px; + will-change: max-height; + } + #tsd-search-input { box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; width: 100%; - padding: 0 10px; - opacity: 0; + padding: 0 0.625rem; /* 10px */ outline: 0; - border: 0; - background: transparent; + border: 2px solid var(--color-accent); + background-color: transparent; color: var(--color-text); + border-radius: 4px; + height: 2.5rem; + flex: 0 0 auto; + font-size: 0.875rem; + transition: border-color 0.2s, background-color 0.2s; } - #tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; + #tsd-search-input:focus-visible { + background-color: var(--color-background-active); + border-color: transparent; + color: var(--color-contrast-text); } - #tsd-search .field input, - #tsd-search .title, - #tsd-toolbar-links a { - transition: opacity 0.2s; + #tsd-search-input::placeholder { + color: inherit; + opacity: 0.8; } - #tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; + #tsd-search-results { margin: 0; padding: 0; list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + flex: 1 1 auto; + display: flex; + flex-direction: column; + overflow-y: auto; + } + #tsd-search-results:not(:empty) { + margin-top: 0.5rem; } - #tsd-search .results li { + #tsd-search-results > li { background-color: var(--color-background); - line-height: initial; - padding: 4px; + line-height: 1.5; + box-sizing: border-box; + border-radius: 4px; } - #tsd-search .results li:nth-child(even) { + #tsd-search-results > li:nth-child(even) { background-color: var(--color-background-secondary); } - #tsd-search .results li.state { - display: none; - } - #tsd-search .results li.current:not(.no-results), - #tsd-search .results li:hover:not(.no-results) { - background-color: var(--color-accent); + #tsd-search-results > li:is(:hover, [aria-selected="true"]) { + background-color: var(--color-background-active); + color: var(--color-contrast-text); } - #tsd-search .results a { + /* It's important that this takes full size of parent `li`, to capture a click on `li` */ + #tsd-search-results > li > a { display: flex; align-items: center; - padding: 0.25rem; + padding: 0.5rem 0.25rem; box-sizing: border-box; + width: 100%; } - #tsd-search .results a:before { - top: 10px; + #tsd-search-results > li > a > .text { + flex: 1 1 auto; + min-width: 0; + overflow-wrap: anywhere; } - #tsd-search .results span.parent { + #tsd-search-results > li > a .parent { color: var(--color-text-aside); - font-weight: normal; - } - #tsd-search.has-focus { - background-color: var(--color-accent); - } - #tsd-search.has-focus .field input { - top: 0; - opacity: 1; - } - #tsd-search.has-focus .title, - #tsd-search.has-focus #tsd-toolbar-links a { - z-index: 0; - opacity: 0; - } - #tsd-search.has-focus .results { - visibility: visible; - } - #tsd-search.loading .results li.state.loading { - display: block; } - #tsd-search.failure .results li.state.failure { - display: block; - } - - #tsd-toolbar-links { - position: absolute; - top: 0; - right: 2rem; - height: 100%; - display: flex; - align-items: center; - justify-content: flex-end; + #tsd-search-results > li > a mark { + color: inherit; + background-color: inherit; + font-weight: bold; } - #tsd-toolbar-links a { - margin-left: 1.5rem; + #tsd-search-status { + flex: 1; + display: grid; + place-content: center; + text-align: center; + overflow-wrap: anywhere; } - #tsd-toolbar-links a:hover { - text-decoration: underline; + #tsd-search-status:not(:empty) { + min-height: 6rem; } .tsd-signature { @@ -1257,78 +1314,52 @@ width: 100%; color: var(--color-text); background: var(--color-background-secondary); - border-bottom: 1px var(--color-accent) solid; + border-bottom: var(--dim-toolbar-border-bottom-width) + var(--color-accent) solid; transition: transform 0.3s ease-in-out; } .tsd-page-toolbar a { color: var(--color-text); - text-decoration: none; - } - .tsd-page-toolbar a.title { - font-weight: bold; } - .tsd-page-toolbar a.title:hover { - text-decoration: underline; - } - .tsd-page-toolbar .tsd-toolbar-contents { + .tsd-toolbar-contents { display: flex; - justify-content: space-between; - height: 2.5rem; + align-items: center; + height: var(--dim-toolbar-contents-height); margin: 0 auto; } - .tsd-page-toolbar .table-cell { - position: relative; - white-space: nowrap; - line-height: 40px; - } - .tsd-page-toolbar .table-cell:first-child { - width: 100%; + .tsd-toolbar-contents > .title { + font-weight: bold; + margin-right: auto; } - .tsd-page-toolbar .tsd-toolbar-icon { - box-sizing: border-box; - line-height: 0; - padding: 12px 0; + #tsd-toolbar-links { + display: flex; + align-items: center; + gap: 1.5rem; + margin-right: 1rem; } .tsd-widget { + box-sizing: border-box; display: inline-block; - overflow: hidden; opacity: 0.8; - height: 40px; - transition: - opacity 0.1s, - background-color 0.2s; - vertical-align: bottom; + height: 2.5rem; + width: 2.5rem; + transition: opacity 0.1s, background-color 0.1s; + text-align: center; cursor: pointer; + border: none; + background-color: transparent; } .tsd-widget:hover { opacity: 0.9; } - .tsd-widget.active { + .tsd-widget:active { opacity: 1; background-color: var(--color-accent); } - .tsd-widget.no-caption { - width: 40px; - } - .tsd-widget.no-caption:before { - margin: 0; - } - - .tsd-widget.options, - .tsd-widget.menu { + #tsd-toolbar-menu-trigger { display: none; } - input[type="checkbox"] + .tsd-widget:before { - background-position: -120px 0; - } - input[type="checkbox"]:checked + .tsd-widget:before { - background-position: -160px 0; - } - - img { - max-width: 100%; - } .tsd-member-summary-name { display: inline-flex; @@ -1342,6 +1373,7 @@ align-items: center; margin-left: 0.5rem; color: var(--color-text); + vertical-align: middle; } .tsd-anchor-icon svg { @@ -1351,7 +1383,8 @@ } .tsd-member-summary-name:hover > .tsd-anchor-icon svg, - .tsd-anchor-link:hover > .tsd-anchor-icon svg { + .tsd-anchor-link:hover > .tsd-anchor-icon svg, + .tsd-anchor-icon:focus-visible svg { visibility: visible; } @@ -1437,41 +1470,26 @@ color: var(--color-text); } - * { - scrollbar-width: thin; - scrollbar-color: var(--color-accent) var(--color-icon-background); - } - - *::-webkit-scrollbar { - width: 0.75rem; - } - - *::-webkit-scrollbar-track { - background: var(--color-icon-background); - } - - *::-webkit-scrollbar-thumb { - background-color: var(--color-accent); - border-radius: 999rem; - border: 0.25rem solid var(--color-icon-background); - } - /* mobile */ @media (max-width: 769px) { - .tsd-widget.options, - .tsd-widget.menu { + #tsd-toolbar-menu-trigger { display: inline-block; + /* temporary fix to vertically align, for compatibility */ + line-height: 2.5; + } + #tsd-toolbar-links { + display: none; } .container-main { display: flex; } - html .col-content { + .col-content { float: none; max-width: 100%; width: 100%; } - html .col-sidebar { + .col-sidebar { position: fixed !important; overflow-y: auto; -webkit-overflow-scrolling: touch; @@ -1486,10 +1504,10 @@ background-color: var(--color-background); transform: translate(100%, 0); } - html .col-sidebar > *:last-child { + .col-sidebar > *:last-child { padding-bottom: 20px; } - html .overlay { + .overlay { content: ""; display: block; position: fixed; @@ -1536,9 +1554,6 @@ .has-menu .tsd-navigation { max-height: 100%; } - #tsd-toolbar-links { - display: none; - } .tsd-navigation .tsd-nav-link { display: flex; } @@ -1550,7 +1565,11 @@ display: grid; grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); grid-template-areas: "sidebar content"; - margin: 2rem auto; + --dim-container-main-margin-y: 2rem; + } + + .tsd-breadcrumb { + margin-top: 0; } .col-sidebar { @@ -1563,11 +1582,15 @@ } @media (min-width: 770px) and (max-width: 1399px) { .col-sidebar { - max-height: calc(100vh - 2rem - 42px); + max-height: calc( + 100vh - var(--dim-header-height) - var(--dim-footer-height) - + 2 * var(--dim-container-main-margin-y) + ); overflow: auto; position: sticky; - top: 42px; - padding-top: 1rem; + top: calc( + var(--dim-header-height) + var(--dim-container-main-margin-y) + ); } .site-menu { margin-top: 1rem; @@ -1577,10 +1600,11 @@ /* two sidebars */ @media (min-width: 1200px) { .container-main { - grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax( - 0, - 20rem - ); + grid-template-columns: + minmax(0, 1fr) minmax(0, 2.5fr) minmax( + 0, + 20rem + ); grid-template-areas: "sidebar content toc"; } @@ -1597,15 +1621,20 @@ } .site-menu { - margin-top: 1rem; + margin-top: 0rem; } .page-menu, .site-menu { - max-height: calc(100vh - 2rem - 42px); + max-height: calc( + 100vh - var(--dim-header-height) - var(--dim-footer-height) - + 2 * var(--dim-container-main-margin-y) + ); overflow: auto; position: sticky; - top: 42px; + top: calc( + var(--dim-header-height) + var(--dim-container-main-margin-y) + ); } } } diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 880214f..b8e8a69 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,58 +1,58 @@ -EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib

    Class EmbeddedLinuxCodeBuildProjectStack

    The stack for creating a build pipeline.

    +EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
    aws4embeddedlinux-cdk-lib
      Preparing search index...

      Class EmbeddedLinuxCodeBuildProjectStack

      The stack for creating a build pipeline.

      See EmbeddedLinuxCodeBuildProjectProps for configration options.

      -

      Hierarchy

      • Stack
        • EmbeddedLinuxCodeBuildProjectStack

      Constructors

      constructor -

      Properties

      tags -templateOptions -region -account -environment -nestedStackResource? -templateFile -artifactId -synthesizer -_versionReportingEnabled -_crossRegionReferences -_notificationArns? -node -

      Accessors

      terminationProtection -dependencies -stackName -partition -urlSuffix -stackId -notificationArns -nested -availabilityZones -nestedStackParent -bundlingRequired -

      Methods

      isStack -of -resolve -toJsonString -toYamlString -reportMissingContextKey -renameLogicalId -getLogicalId -addDependency -formatArn -splitArn -addTransform -addMetadata -_addAssemblyDependency -_obtainAssemblyDependencies -_removeAssemblyDependency -_synthesizeTemplate -regionalFact -exportValue -exportStringListValue -allocateLogicalId -_validateId -_toCloudFormation -isConstruct -toString -

      Constructors

      constructor

      Properties

      Readonlytags

      tags: TagManager

      Tags to be applied to the stack.

      -

      ReadonlytemplateOptions

      templateOptions: ITemplateOptions

      Options for CloudFormation template (like version, transform, description).

      -

      Readonlyregion

      region: string

      The AWS region into which this stack will be deployed (e.g. us-west-2).

      +

      Hierarchy

      • Stack
        • EmbeddedLinuxCodeBuildProjectStack
      Index

      Constructors

      constructor +

      Properties

      tags +templateOptions +region +account +environment +nestedStackResource? +templateFile +artifactId +synthesizer +_versionReportingEnabled +_crossRegionReferences +_notificationArns? +node +

      Accessors

      terminationProtection +dependencies +stackName +partition +urlSuffix +stackId +notificationArns +nested +availabilityZones +nestedStackParent +bundlingRequired +

      Methods

      isStack +of +resolve +toJsonString +toYamlString +reportMissingContextKey +renameLogicalId +getLogicalId +addDependency +formatArn +splitArn +addTransform +addMetadata +_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate +regionalFact +exportValue +exportStringListValue +allocateLogicalId +_validateId +_toCloudFormation +isConstruct +toString +

      Constructors

      Properties

      tags: TagManager

      Tags to be applied to the stack.

      +
      templateOptions: ITemplateOptions

      Options for CloudFormation template (like version, transform, description).

      +
      region: string

      The AWS region into which this stack will be deployed (e.g. us-west-2).

      This value is resolved according to the following rules:

      1. The value provided to env.region when the stack is defined. This can @@ -69,7 +69,7 @@ into a region-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

        -

      Readonlyaccount

      account: string

      The AWS account into which this stack will be deployed.

      +
      account: string

      The AWS account into which this stack will be deployed.

      This value is resolved according to the following rules:

      1. The value provided to env.account when the stack is defined. This can @@ -83,10 +83,10 @@ check that it is a concrete value an not an unresolved token. If this value is an unresolved token (Token.isUnresolved(stack.account) returns true), this implies that the user wishes that this stack will synthesize -into a account-agnostic template. In this case, your code should either +into an account-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or -implement some other region-agnostic behavior.

        -

      Readonlyenvironment

      environment: string

      The environment coordinates in which this stack is deployed. In the form +implement some other account-agnostic behavior.

      +
      environment: string

      The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

      You can use this value to determine if two stacks are targeting the same @@ -95,21 +95,21 @@ Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

      -

      Optional ReadonlynestedStackResource

      nestedStackResource?: CfnResource

      If this is a nested stack, this represents its AWS::CloudFormation::Stack +

      nestedStackResource?: CfnResource

      If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

      -

      ReadonlytemplateFile

      templateFile: string

      The name of the CloudFormation template file emitted to the output +

      templateFile: string

      The name of the CloudFormation template file emitted to the output directory during synthesis.

      Example value: MyStack.template.json

      -

      ReadonlyartifactId

      artifactId: string

      The ID of the cloud assembly artifact for this stack.

      -

      Readonlysynthesizer

      synthesizer: IStackSynthesizer

      Synthesis method for this stack

      -

      Readonly Internal_versionReportingEnabled

      _versionReportingEnabled: boolean

      Whether version reporting is enabled for this stack

      +
      artifactId: string

      The ID of the cloud assembly artifact for this stack.

      +
      synthesizer: IStackSynthesizer

      Synthesis method for this stack

      +

      Readonly Internal_versionReportingEnabled

      _versionReportingEnabled: boolean

      Whether version reporting is enabled for this stack

      Controls whether the CDK Metadata resource is injected

      -

      Readonly Internal_crossRegionReferences

      _crossRegionReferences: boolean

      Whether cross region references are enabled for this stack

      -

      Optional Readonly Internal_notificationArns

      _notificationArns?: string[]

      SNS Notification ARNs to receive stack events.

      -

      Readonlynode

      node: Node

      The tree node.

      -

      Accessors

      terminationProtection

      • get terminationProtection(): boolean

        Whether termination protection is enabled for this stack.

        -

        Returns boolean

      • set terminationProtection(value: boolean): void

        Parameters

        • value: boolean

        Returns void

      dependencies

      • get dependencies(): Stack[]

        Return the stacks this stack depends on

        -

        Returns Stack[]

      stackName

      • get stackName(): string

        The concrete CloudFormation physical stack name.

        +

      Readonly Internal_crossRegionReferences

      _crossRegionReferences: boolean

      Whether cross region references are enabled for this stack

      +

      Optional Readonly Internal_notificationArns

      _notificationArns?: string[]

      SNS Notification ARNs to receive stack events.

      +
      node: Node

      The tree node.

      +

      Accessors

      • get terminationProtection(): boolean

        Whether termination protection is enabled for this stack.

        +

        Returns boolean

      • set terminationProtection(value: boolean): void

        Parameters

        • value: boolean

        Returns void

      • get dependencies(): Stack[]

        Return the stacks this stack depends on

        +

        Returns Stack[]

      • get stackName(): string

        The concrete CloudFormation physical stack name.

        This is either the name defined explicitly in the stackName prop or allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack @@ -117,15 +117,15 @@ scheme based on the construct path to ensure uniqueness.

        If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.

        -

        Returns string

      partition

      • get partition(): string

        The partition in which this stack is defined

        -

        Returns string

      urlSuffix

      • get urlSuffix(): string

        The Amazon domain suffix for the region in which this stack is defined

        -

        Returns string

      stackId

      • get stackId(): string

        The ID of the stack

        -

        Returns string

        Example

        // After resolving, looks like
        'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+

        Returns string

      • get partition(): string

        The partition in which this stack is defined

        +

        Returns string

      • get urlSuffix(): string

        The Amazon domain suffix for the region in which this stack is defined

        +

        Returns string

      • get stackId(): string

        The ID of the stack

        +

        Returns string

        // After resolving, looks like
        'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
        -

      notificationArns

      • get notificationArns(): string[]

        Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

        -

        Returns string[]

      nested

      • get nested(): boolean

        Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

        -

        Returns boolean

      availabilityZones

      • get availabilityZones(): string[]

        Returns the list of AZs that are available in the AWS environment +

      • get notificationArns(): string[]

        Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

        +

        Returns string[]

      • get nested(): boolean

        Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

        +

        Returns boolean

      • get availabilityZones(): string[]

        Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

        If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve @@ -135,23 +135,23 @@ reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

        To specify a different strategy for selecting availability zones override this method.

        -

        Returns string[]

      nestedStackParent

      • get nestedStackParent(): undefined | Stack

        If this is a nested stack, returns it's parent stack.

        -

        Returns undefined | Stack

      bundlingRequired

      • get bundlingRequired(): boolean

        Indicates whether the stack requires bundling or not

        -

        Returns boolean

      Methods

      StaticisStack

      • isStack(x: any): x is Stack

        Return whether the given object is a Stack.

        +

        Returns string[]

      • get nestedStackParent(): undefined | Stack

        If this is a nested stack, returns it's parent stack.

        +

        Returns undefined | Stack

      • get bundlingRequired(): boolean

        Indicates whether the stack requires bundling or not

        +

        Returns boolean

      Methods

      • Return whether the given object is a Stack.

        We do attribute detection since we can't reliably use 'instanceof'.

        -

        Parameters

        • x: any

        Returns x is Stack

      Staticof

      • of(construct: IConstruct): Stack

        Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

        +

        Parameters

        • this: void
        • x: any

        Returns x is Stack

      • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

        Parameters

        • construct: IConstruct

          The construct to start the search from.

          -

        Returns Stack

      resolve

      • resolve(obj: any): any

        Resolve a tokenized value in the context of the current stack.

        -

        Parameters

        • obj: any

        Returns any

      toJsonString

      • toJsonString(obj: any, space?: number): string

        Convert an object, potentially containing tokens, to a JSON string

        -

        Parameters

        • obj: any
        • Optionalspace: number

        Returns string

      toYamlString

      • toYamlString(obj: any): string

        Convert an object, potentially containing tokens, to a YAML string

        -

        Parameters

        • obj: any

        Returns string

      reportMissingContextKey

      • reportMissingContextKey(report: MissingContext): void

        Indicate that a context key was expected

        +

      Returns Stack

      • Resolve a tokenized value in the context of the current stack.

        +

        Parameters

        • obj: any

        Returns any

      • Convert an object, potentially containing tokens, to a JSON string

        +

        Parameters

        • this: void
        • obj: any
        • Optionalspace: number

        Returns string

      • Convert an object, potentially containing tokens, to a YAML string

        +

        Parameters

        • obj: any

        Returns string

      • Indicate that a context key was expected

        Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

        Parameters

        • report: MissingContext

          The set of parameters needed to obtain the context

          -

        Returns void

      renameLogicalId

      • renameLogicalId(oldId: string, newId: string): void

        Rename a generated logical identities

        +

      Returns void

      • Rename a generated logical identities

        To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

        -

        Parameters

        • oldId: string
        • newId: string

        Returns void

      getLogicalId

      • getLogicalId(element: CfnElement): string

        Allocates a stack-unique CloudFormation-compatible logical identity for a +

        Parameters

        • oldId: string
        • newId: string

        Returns void

      • Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.

        This method is called when a CfnElement is created and used to render the initial logical identity of resources. Logical ID renames are applied at @@ -161,10 +161,10 @@ class and override this method.

        Parameters

        • element: CfnElement

          The CloudFormation element for which a logical identity is needed.

          -

        Returns string

      addDependency

      • addDependency(target: Stack, reason?: string): void

        Add a dependency between this stack and another stack.

        +

      Returns string

      • Add a dependency between this stack and another stack.

        This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

        -

        Parameters

        • target: Stack
        • Optionalreason: string

        Returns void

      formatArn

      • formatArn(components: ArnComponents): string

        Creates an ARN from components.

        +

        Parameters

        • target: Stack
        • Optionalreason: string

        Returns void

      • Creates an ARN from components.

        If partition, region or account are not specified, the stack's partition, region and account will be used.

        If any component is the empty string, an empty string will be inserted @@ -174,37 +174,37 @@

        The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'.

        -

        Parameters

        • components: ArnComponents

        Returns string

      splitArn

      • splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

        Splits the provided ARN into its components. +

        Parameters

        • components: ArnComponents

        Returns string

      • Splits the provided ARN into its components. Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

        Parameters

        • arn: string

          the ARN to split into its components

        • arnFormat: ArnFormat

          the expected format of 'arn' - depends on what format the service 'arn' represents uses

          -

        Returns ArnComponents

      addTransform

      • addTransform(transform: string): void

        Add a Transform to this stack. A Transform is a macro that AWS +

      Returns ArnComponents

      Returns void

      https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

      +
      declare const stack: Stack;

      stack.addTransform('AWS::Serverless-2016-10-31')
      -

      addMetadata

      • addMetadata(key: string, value: any): void

        Adds an arbitrary key-value pair, with information you want to record about the stack. +

      _addAssemblyDependency

      _addAssemblyDependency

      • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
        Internal

        Called implicitly by the addDependency helper function in order to realize a dependency between two top-level stacks at the assembly level.

        Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

        -

        Parameters

        • target: Stack
        • Optionalreason: StackDependencyReason

        Returns void

      _obtainAssemblyDependencies

      • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
        Internal

        Called implicitly by the obtainDependencies helper function in order to +

        Parameters

        • target: Stack
        • Optionalreason: StackDependencyReason

        Returns void

      _obtainAssemblyDependencies

      • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
        Internal

        Called implicitly by the obtainDependencies helper function in order to collect resource dependencies across two top-level stacks at the assembly level.

        Use stack.obtainDependencies to see the dependencies between any two stacks.

        -

        Parameters

        • reasonFilter: StackDependencyReason

        Returns Element[]

      _removeAssemblyDependency

      • _removeAssemblyDependency(
            target: Stack,
            reasonFilter?: StackDependencyReason,
        ): void
        Internal

        Called implicitly by the removeDependency helper function in order to +

        Parameters

        • reasonFilter: StackDependencyReason

        Returns Element[]

      _removeAssemblyDependency

      • _removeAssemblyDependency(
            target: Stack,
            reasonFilter?: StackDependencyReason,
        ): void
        Internal

        Called implicitly by the removeDependency helper function in order to remove a dependency between two top-level stacks at the assembly level.

        Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

        -

        Parameters

        • target: Stack
        • OptionalreasonFilter: StackDependencyReason

        Returns void

      _synthesizeTemplate

      • _synthesizeTemplate(
            session: ISynthesisSession,
            lookupRoleArn?: string,
            lookupRoleExternalId?: string,
            lookupRoleAdditionalOptions?: { [key: string]: any },
        ): void
        Internal

        Synthesizes the cloudformation template into a cloud assembly.

        -

        Parameters

        • session: ISynthesisSession
        • OptionallookupRoleArn: string
        • OptionallookupRoleExternalId: string
        • OptionallookupRoleAdditionalOptions: { [key: string]: any }

        Returns void

      regionalFact

      • regionalFact(factName: string, defaultValue?: string): string

        Look up a fact value for the given fact for the region of this stack

        +

        Parameters

        • target: Stack
        • OptionalreasonFilter: StackDependencyReason

        Returns void

      _synthesizeTemplate

      • _synthesizeTemplate(
            session: ISynthesisSession,
            lookupRoleArn?: string,
            lookupRoleExternalId?: string,
            lookupRoleAdditionalOptions?: { [key: string]: any },
        ): void
        Internal

        Synthesizes the cloudformation template into a cloud assembly.

        +

        Parameters

        • session: ISynthesisSession
        • OptionallookupRoleArn: string
        • OptionallookupRoleExternalId: string
        • OptionallookupRoleAdditionalOptions: { [key: string]: any }

        Returns void

      • Look up a fact value for the given fact for the region of this stack

        Will return a definite value only if the region of the current stack is resolved. If not, a lookup map will be added to the stack and the lookup will be done at CDK deployment time.

        @@ -217,7 +217,7 @@ not have to worry about regional facts.

        If defaultValue is not given, it is an error if the fact is unknown for the given region.

        -

        Parameters

        • factName: string
        • OptionaldefaultValue: string

        Returns string

      exportValue

      • exportValue(exportedValue: any, options?: ExportValueOptions): string

        Create a CloudFormation Export for a string value

        +

        Parameters

        • factName: string
        • OptionaldefaultValue: string

        Returns string

      • Create a CloudFormation Export for a string value

        Returns a string representing the corresponding Fn.importValue() expression for this Export. You can control the name for the export by passing the name option.

        @@ -253,7 +253,7 @@
      • Don't forget to remove the exportValue() call as well.
      • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
      -

      Parameters

      • exportedValue: any
      • Optionaloptions: ExportValueOptions

      Returns string

      exportStringListValue

      • exportStringListValue(
            exportedValue: any,
            options?: ExportValueOptions,
        ): string[]

        Create a CloudFormation Export for a string list value

        +

        Parameters

        • exportedValue: any
        • Optionaloptions: ExportValueOptions

        Returns string

      • Create a CloudFormation Export for a string list value

        Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only @@ -268,7 +268,7 @@ remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

        See exportValue for an example of this process.

        -

        Parameters

        • exportedValue: any
        • Optionaloptions: ExportValueOptions

        Returns string[]

      ProtectedallocateLogicalId

      • allocateLogicalId(cfnElement: CfnElement): string

        Returns the naming scheme used to allocate logical IDs. By default, uses +

        Parameters

        • exportedValue: any
        • Optionaloptions: ExportValueOptions

        Returns string[]

      • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize this behavior.

        In order to make sure logical IDs are unique and stable, we hash the resource @@ -300,12 +300,12 @@ part of the identifier.

      Parameters

      • cfnElement: CfnElement

        The element for which the logical ID is allocated.

        -

      Returns string

      Protected_validateId

      • _validateId(name: string): void
        Internal

        Validate stack name

        +

      Returns string

      Protected_validateId

      • _validateId(name: string): void
        Internal

        Validate stack name

        CloudFormation stack names can include dashes in addition to the regular identifier character classes, and we don't allow one of the magic markers.

        -

        Parameters

        • name: string

        Returns void

      Protected_toCloudFormation

      • _toCloudFormation(): any
        Internal

        Returns the CloudFormation template for this stack by traversing +

        Parameters

        • name: string

        Returns void

      Protected_toCloudFormation

      • _toCloudFormation(): any
        Internal

        Returns the CloudFormation template for this stack by traversing the tree and invoking _toCloudFormation() on all Entity objects.

        -

        Returns any

      StaticisConstruct

      • isConstruct(x: any): x is Construct

        Checks if x is a construct.

        +

        Returns any

      • Checks if x is a construct.

        Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

        Explanation: in JavaScript, multiple copies of the constructs library on @@ -320,5 +320,5 @@ this type-testing method instead.

        Parameters

        • x: any

          Any object

        Returns x is Construct

        true if x is an object created from a class which extends Construct.

        -

      toString

      • toString(): string

        Returns a string representation of this construct.

        -

        Returns string

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      Accessors
      Methods
      +

      • Returns a string representation of this construct.

        +

        Returns string

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      Accessors
      Methods
      diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 18ee9a7..a8a6dd9 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,63 +1,61 @@ -EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib

      Class EmbeddedLinuxCodePipelineBaseImageStack

      The pipeline for building the CodeBuild Image used in other pipelines. This +EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib

      aws4embeddedlinux-cdk-lib
        Preparing search index...

        Class EmbeddedLinuxCodePipelineBaseImageStack

        The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

        For configuration options see BuildBaseImageCodePipelineProps.

        -

        Hierarchy

        • Stack
          • EmbeddedLinuxCodePipelineBaseImageStack

        Constructors

        constructor -

        Properties

        ecrRepository -ecrRepositoryImageTag -tags -templateOptions -region -account -environment -nestedStackResource? -templateFile -artifactId -synthesizer -_versionReportingEnabled -_crossRegionReferences -_notificationArns? -node -

        Accessors

        terminationProtection -dependencies -stackName -partition -urlSuffix -stackId -notificationArns -nested -availabilityZones -nestedStackParent -bundlingRequired -

        Methods

        isStack -of -resolve -toJsonString -toYamlString -reportMissingContextKey -renameLogicalId -getLogicalId -addDependency -formatArn -splitArn -addTransform -addMetadata -_addAssemblyDependency -_obtainAssemblyDependencies -_removeAssemblyDependency -_synthesizeTemplate -regionalFact -exportValue -exportStringListValue -allocateLogicalId -_validateId -_toCloudFormation -isConstruct -toString -

        Constructors

        constructor

        Properties

        ReadonlyecrRepository

        ecrRepository: IRepository

        The ECR Repository where the image is located.

        -

        ReadonlyecrRepositoryImageTag

        ecrRepositoryImageTag: string

        The ECR Image Tag to find the base imaged.

        -

        Readonlytags

        tags: TagManager

        Tags to be applied to the stack.

        -

        ReadonlytemplateOptions

        templateOptions: ITemplateOptions

        Options for CloudFormation template (like version, transform, description).

        -

        Readonlyregion

        region: string

        The AWS region into which this stack will be deployed (e.g. us-west-2).

        +

        Hierarchy

        • Stack
          • EmbeddedLinuxCodePipelineBaseImageStack
        Index

        Constructors

        constructor +

        Properties

        tags +templateOptions +region +account +environment +nestedStackResource? +templateFile +artifactId +synthesizer +_versionReportingEnabled +_crossRegionReferences +_notificationArns? +ecrRepository +ecrRepositoryImageTag +node +

        Accessors

        terminationProtection +dependencies +stackName +partition +urlSuffix +stackId +notificationArns +nested +availabilityZones +nestedStackParent +bundlingRequired +

        Methods

        isStack +of +resolve +toJsonString +toYamlString +reportMissingContextKey +renameLogicalId +getLogicalId +addDependency +formatArn +splitArn +addTransform +addMetadata +_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate +regionalFact +exportValue +exportStringListValue +allocateLogicalId +_validateId +_toCloudFormation +isConstruct +toString +

        Constructors

        Properties

        tags: TagManager

        Tags to be applied to the stack.

        +
        templateOptions: ITemplateOptions

        Options for CloudFormation template (like version, transform, description).

        +
        region: string

        The AWS region into which this stack will be deployed (e.g. us-west-2).

        This value is resolved according to the following rules:

        1. The value provided to env.region when the stack is defined. This can @@ -74,7 +72,7 @@ into a region-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

          -

        Readonlyaccount

        account: string

        The AWS account into which this stack will be deployed.

        +
        account: string

        The AWS account into which this stack will be deployed.

        This value is resolved according to the following rules:

        1. The value provided to env.account when the stack is defined. This can @@ -88,10 +86,10 @@ check that it is a concrete value an not an unresolved token. If this value is an unresolved token (Token.isUnresolved(stack.account) returns true), this implies that the user wishes that this stack will synthesize -into a account-agnostic template. In this case, your code should either +into an account-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or -implement some other region-agnostic behavior.

          -

        Readonlyenvironment

        environment: string

        The environment coordinates in which this stack is deployed. In the form +implement some other account-agnostic behavior.

        +
        environment: string

        The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

        You can use this value to determine if two stacks are targeting the same @@ -100,21 +98,23 @@ Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

        -

        Optional ReadonlynestedStackResource

        nestedStackResource?: CfnResource

        If this is a nested stack, this represents its AWS::CloudFormation::Stack +

        nestedStackResource?: CfnResource

        If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

        -

        ReadonlytemplateFile

        templateFile: string

        The name of the CloudFormation template file emitted to the output +

        templateFile: string

        The name of the CloudFormation template file emitted to the output directory during synthesis.

        Example value: MyStack.template.json

        -

        ReadonlyartifactId

        artifactId: string

        The ID of the cloud assembly artifact for this stack.

        -

        Readonlysynthesizer

        synthesizer: IStackSynthesizer

        Synthesis method for this stack

        -

        Readonly Internal_versionReportingEnabled

        _versionReportingEnabled: boolean

        Whether version reporting is enabled for this stack

        +
        artifactId: string

        The ID of the cloud assembly artifact for this stack.

        +
        synthesizer: IStackSynthesizer

        Synthesis method for this stack

        +

        Readonly Internal_versionReportingEnabled

        _versionReportingEnabled: boolean

        Whether version reporting is enabled for this stack

        Controls whether the CDK Metadata resource is injected

        -

        Readonly Internal_crossRegionReferences

        _crossRegionReferences: boolean

        Whether cross region references are enabled for this stack

        -

        Optional Readonly Internal_notificationArns

        _notificationArns?: string[]

        SNS Notification ARNs to receive stack events.

        -

        Readonlynode

        node: Node

        The tree node.

        -

        Accessors

        terminationProtection

        • get terminationProtection(): boolean

          Whether termination protection is enabled for this stack.

          -

          Returns boolean

        • set terminationProtection(value: boolean): void

          Parameters

          • value: boolean

          Returns void

        dependencies

        • get dependencies(): Stack[]

          Return the stacks this stack depends on

          -

          Returns Stack[]

        stackName

        • get stackName(): string

          The concrete CloudFormation physical stack name.

          +

        Readonly Internal_crossRegionReferences

        _crossRegionReferences: boolean

        Whether cross region references are enabled for this stack

        +

        Optional Readonly Internal_notificationArns

        _notificationArns?: string[]

        SNS Notification ARNs to receive stack events.

        +
        ecrRepository: IRepository

        The ECR Repository where the image is located.

        +
        ecrRepositoryImageTag: string

        The ECR Image Tag to find the base imaged.

        +
        node: Node

        The tree node.

        +

        Accessors

        • get terminationProtection(): boolean

          Whether termination protection is enabled for this stack.

          +

          Returns boolean

        • set terminationProtection(value: boolean): void

          Parameters

          • value: boolean

          Returns void

        • get dependencies(): Stack[]

          Return the stacks this stack depends on

          +

          Returns Stack[]

        • get stackName(): string

          The concrete CloudFormation physical stack name.

          This is either the name defined explicitly in the stackName prop or allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack @@ -122,15 +122,15 @@ scheme based on the construct path to ensure uniqueness.

          If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.

          -

          Returns string

        partition

        • get partition(): string

          The partition in which this stack is defined

          -

          Returns string

        urlSuffix

        • get urlSuffix(): string

          The Amazon domain suffix for the region in which this stack is defined

          -

          Returns string

        stackId

        • get stackId(): string

          The ID of the stack

          -

          Returns string

          Example

          // After resolving, looks like
          'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+

          Returns string

        • get partition(): string

          The partition in which this stack is defined

          +

          Returns string

        • get urlSuffix(): string

          The Amazon domain suffix for the region in which this stack is defined

          +

          Returns string

        • get stackId(): string

          The ID of the stack

          +

          Returns string

          // After resolving, looks like
          'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
          -

        notificationArns

        • get notificationArns(): string[]

          Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

          -

          Returns string[]

        nested

        • get nested(): boolean

          Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

          -

          Returns boolean

        availabilityZones

        • get availabilityZones(): string[]

          Returns the list of AZs that are available in the AWS environment +

        • get notificationArns(): string[]

          Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

          +

          Returns string[]

        • get nested(): boolean

          Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

          +

          Returns boolean

        • get availabilityZones(): string[]

          Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

          If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve @@ -140,23 +140,23 @@ reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

          To specify a different strategy for selecting availability zones override this method.

          -

          Returns string[]

        nestedStackParent

        • get nestedStackParent(): undefined | Stack

          If this is a nested stack, returns it's parent stack.

          -

          Returns undefined | Stack

        bundlingRequired

        • get bundlingRequired(): boolean

          Indicates whether the stack requires bundling or not

          -

          Returns boolean

        Methods

        StaticisStack

        • isStack(x: any): x is Stack

          Return whether the given object is a Stack.

          +

          Returns string[]

        • get nestedStackParent(): undefined | Stack

          If this is a nested stack, returns it's parent stack.

          +

          Returns undefined | Stack

        • get bundlingRequired(): boolean

          Indicates whether the stack requires bundling or not

          +

          Returns boolean

        Methods

        • Return whether the given object is a Stack.

          We do attribute detection since we can't reliably use 'instanceof'.

          -

          Parameters

          • x: any

          Returns x is Stack

        Staticof

        • of(construct: IConstruct): Stack

          Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

          +

          Parameters

          • this: void
          • x: any

          Returns x is Stack

        • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

          Parameters

          • construct: IConstruct

            The construct to start the search from.

            -

          Returns Stack

        resolve

        • resolve(obj: any): any

          Resolve a tokenized value in the context of the current stack.

          -

          Parameters

          • obj: any

          Returns any

        toJsonString

        • toJsonString(obj: any, space?: number): string

          Convert an object, potentially containing tokens, to a JSON string

          -

          Parameters

          • obj: any
          • Optionalspace: number

          Returns string

        toYamlString

        • toYamlString(obj: any): string

          Convert an object, potentially containing tokens, to a YAML string

          -

          Parameters

          • obj: any

          Returns string

        reportMissingContextKey

        • reportMissingContextKey(report: MissingContext): void

          Indicate that a context key was expected

          +

        Returns Stack

        • Resolve a tokenized value in the context of the current stack.

          +

          Parameters

          • obj: any

          Returns any

        • Convert an object, potentially containing tokens, to a JSON string

          +

          Parameters

          • this: void
          • obj: any
          • Optionalspace: number

          Returns string

        • Convert an object, potentially containing tokens, to a YAML string

          +

          Parameters

          • obj: any

          Returns string

        • Indicate that a context key was expected

          Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

          Parameters

          • report: MissingContext

            The set of parameters needed to obtain the context

            -

          Returns void

        renameLogicalId

        • renameLogicalId(oldId: string, newId: string): void

          Rename a generated logical identities

          +

        Returns void

        • Rename a generated logical identities

          To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

          -

          Parameters

          • oldId: string
          • newId: string

          Returns void

        getLogicalId

        • getLogicalId(element: CfnElement): string

          Allocates a stack-unique CloudFormation-compatible logical identity for a +

          Parameters

          • oldId: string
          • newId: string

          Returns void

        • Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.

          This method is called when a CfnElement is created and used to render the initial logical identity of resources. Logical ID renames are applied at @@ -166,10 +166,10 @@ class and override this method.

          Parameters

          • element: CfnElement

            The CloudFormation element for which a logical identity is needed.

            -

          Returns string

        addDependency

        • addDependency(target: Stack, reason?: string): void

          Add a dependency between this stack and another stack.

          +

        Returns string

        • Add a dependency between this stack and another stack.

          This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

          -

          Parameters

          • target: Stack
          • Optionalreason: string

          Returns void

        formatArn

        • formatArn(components: ArnComponents): string

          Creates an ARN from components.

          +

          Parameters

          • target: Stack
          • Optionalreason: string

          Returns void

        • Creates an ARN from components.

          If partition, region or account are not specified, the stack's partition, region and account will be used.

          If any component is the empty string, an empty string will be inserted @@ -179,37 +179,37 @@

          The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'.

          -

          Parameters

          • components: ArnComponents

          Returns string

        splitArn

        • splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

          Splits the provided ARN into its components. +

          Parameters

          • components: ArnComponents

          Returns string

        • Splits the provided ARN into its components. Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

          Parameters

          • arn: string

            the ARN to split into its components

          • arnFormat: ArnFormat

            the expected format of 'arn' - depends on what format the service 'arn' represents uses

            -

          Returns ArnComponents

        addTransform

        • addTransform(transform: string): void

          Add a Transform to this stack. A Transform is a macro that AWS +

        Returns ArnComponents

        Returns void

        https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

        +
        declare const stack: Stack;

        stack.addTransform('AWS::Serverless-2016-10-31')
        -

        addMetadata

        • addMetadata(key: string, value: any): void

          Adds an arbitrary key-value pair, with information you want to record about the stack. +

        _addAssemblyDependency

        _addAssemblyDependency

        • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
          Internal

          Called implicitly by the addDependency helper function in order to realize a dependency between two top-level stacks at the assembly level.

          Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

          -

          Parameters

          • target: Stack
          • Optionalreason: StackDependencyReason

          Returns void

        _obtainAssemblyDependencies

        • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
          Internal

          Called implicitly by the obtainDependencies helper function in order to +

          Parameters

          • target: Stack
          • Optionalreason: StackDependencyReason

          Returns void

        _obtainAssemblyDependencies

        • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
          Internal

          Called implicitly by the obtainDependencies helper function in order to collect resource dependencies across two top-level stacks at the assembly level.

          Use stack.obtainDependencies to see the dependencies between any two stacks.

          -

          Parameters

          • reasonFilter: StackDependencyReason

          Returns Element[]

        _removeAssemblyDependency

        • _removeAssemblyDependency(
              target: Stack,
              reasonFilter?: StackDependencyReason,
          ): void
          Internal

          Called implicitly by the removeDependency helper function in order to +

          Parameters

          • reasonFilter: StackDependencyReason

          Returns Element[]

        _removeAssemblyDependency

        • _removeAssemblyDependency(
              target: Stack,
              reasonFilter?: StackDependencyReason,
          ): void
          Internal

          Called implicitly by the removeDependency helper function in order to remove a dependency between two top-level stacks at the assembly level.

          Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

          -

          Parameters

          • target: Stack
          • OptionalreasonFilter: StackDependencyReason

          Returns void

        _synthesizeTemplate

        • _synthesizeTemplate(
              session: ISynthesisSession,
              lookupRoleArn?: string,
              lookupRoleExternalId?: string,
              lookupRoleAdditionalOptions?: { [key: string]: any },
          ): void
          Internal

          Synthesizes the cloudformation template into a cloud assembly.

          -

          Parameters

          • session: ISynthesisSession
          • OptionallookupRoleArn: string
          • OptionallookupRoleExternalId: string
          • OptionallookupRoleAdditionalOptions: { [key: string]: any }

          Returns void

        regionalFact

        • regionalFact(factName: string, defaultValue?: string): string

          Look up a fact value for the given fact for the region of this stack

          +

          Parameters

          • target: Stack
          • OptionalreasonFilter: StackDependencyReason

          Returns void

        _synthesizeTemplate

        • _synthesizeTemplate(
              session: ISynthesisSession,
              lookupRoleArn?: string,
              lookupRoleExternalId?: string,
              lookupRoleAdditionalOptions?: { [key: string]: any },
          ): void
          Internal

          Synthesizes the cloudformation template into a cloud assembly.

          +

          Parameters

          • session: ISynthesisSession
          • OptionallookupRoleArn: string
          • OptionallookupRoleExternalId: string
          • OptionallookupRoleAdditionalOptions: { [key: string]: any }

          Returns void

        • Look up a fact value for the given fact for the region of this stack

          Will return a definite value only if the region of the current stack is resolved. If not, a lookup map will be added to the stack and the lookup will be done at CDK deployment time.

          @@ -222,7 +222,7 @@ not have to worry about regional facts.

          If defaultValue is not given, it is an error if the fact is unknown for the given region.

          -

          Parameters

          • factName: string
          • OptionaldefaultValue: string

          Returns string

        exportValue

        • exportValue(exportedValue: any, options?: ExportValueOptions): string

          Create a CloudFormation Export for a string value

          +

          Parameters

          • factName: string
          • OptionaldefaultValue: string

          Returns string

        • Create a CloudFormation Export for a string value

          Returns a string representing the corresponding Fn.importValue() expression for this Export. You can control the name for the export by passing the name option.

          @@ -258,7 +258,7 @@
        • Don't forget to remove the exportValue() call as well.
        • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
        -

        Parameters

        • exportedValue: any
        • Optionaloptions: ExportValueOptions

        Returns string

        exportStringListValue

        • exportStringListValue(
              exportedValue: any,
              options?: ExportValueOptions,
          ): string[]

          Create a CloudFormation Export for a string list value

          +

          Parameters

          • exportedValue: any
          • Optionaloptions: ExportValueOptions

          Returns string

        • Create a CloudFormation Export for a string list value

          Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only @@ -273,7 +273,7 @@ remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

          See exportValue for an example of this process.

          -

          Parameters

          • exportedValue: any
          • Optionaloptions: ExportValueOptions

          Returns string[]

        ProtectedallocateLogicalId

        • allocateLogicalId(cfnElement: CfnElement): string

          Returns the naming scheme used to allocate logical IDs. By default, uses +

          Parameters

          • exportedValue: any
          • Optionaloptions: ExportValueOptions

          Returns string[]

        • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize this behavior.

          In order to make sure logical IDs are unique and stable, we hash the resource @@ -305,12 +305,12 @@ part of the identifier.

        Parameters

        • cfnElement: CfnElement

          The element for which the logical ID is allocated.

          -

        Returns string

        Protected_validateId

        • _validateId(name: string): void
          Internal

          Validate stack name

          +

        Returns string

        Protected_validateId

        • _validateId(name: string): void
          Internal

          Validate stack name

          CloudFormation stack names can include dashes in addition to the regular identifier character classes, and we don't allow one of the magic markers.

          -

          Parameters

          • name: string

          Returns void

        Protected_toCloudFormation

        • _toCloudFormation(): any
          Internal

          Returns the CloudFormation template for this stack by traversing +

          Parameters

          • name: string

          Returns void

        Protected_toCloudFormation

        • _toCloudFormation(): any
          Internal

          Returns the CloudFormation template for this stack by traversing the tree and invoking _toCloudFormation() on all Entity objects.

          -

          Returns any

        StaticisConstruct

        • isConstruct(x: any): x is Construct

          Checks if x is a construct.

          +

          Returns any

        • Checks if x is a construct.

          Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

          Explanation: in JavaScript, multiple copies of the constructs library on @@ -325,5 +325,5 @@ this type-testing method instead.

          Parameters

          • x: any

            Any object

          Returns x is Construct

          true if x is an object created from a class which extends Construct.

          -

        toString

        • toString(): string

          Returns a string representation of this construct.

          -

          Returns string

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        +

        • Returns a string representation of this construct.

          +

          Returns string

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        diff --git a/classes/EmbeddedLinuxCodePipelineStack.html b/classes/EmbeddedLinuxCodePipelineStack.html index 4a5b0c0..109fb14 100644 --- a/classes/EmbeddedLinuxCodePipelineStack.html +++ b/classes/EmbeddedLinuxCodePipelineStack.html @@ -1,58 +1,58 @@ -EmbeddedLinuxCodePipelineStack | aws4embeddedlinux-cdk-lib

        Class EmbeddedLinuxCodePipelineStack

        The stack for creating a build pipeline.

        +EmbeddedLinuxCodePipelineStack | aws4embeddedlinux-cdk-lib
        aws4embeddedlinux-cdk-lib
          Preparing search index...

          Class EmbeddedLinuxCodePipelineStack

          The stack for creating a build pipeline.

          See EmbeddedLinuxCodePipelineProps for configration options.

          -

          Hierarchy

          • Stack
            • EmbeddedLinuxCodePipelineStack

          Constructors

          constructor -

          Properties

          tags -templateOptions -region -account -environment -nestedStackResource? -templateFile -artifactId -synthesizer -_versionReportingEnabled -_crossRegionReferences -_notificationArns? -node -

          Accessors

          terminationProtection -dependencies -stackName -partition -urlSuffix -stackId -notificationArns -nested -availabilityZones -nestedStackParent -bundlingRequired -

          Methods

          isStack -of -resolve -toJsonString -toYamlString -reportMissingContextKey -renameLogicalId -getLogicalId -addDependency -formatArn -splitArn -addTransform -addMetadata -_addAssemblyDependency -_obtainAssemblyDependencies -_removeAssemblyDependency -_synthesizeTemplate -regionalFact -exportValue -exportStringListValue -allocateLogicalId -_validateId -_toCloudFormation -isConstruct -toString -

          Constructors

          constructor

          Properties

          Readonlytags

          tags: TagManager

          Tags to be applied to the stack.

          -

          ReadonlytemplateOptions

          templateOptions: ITemplateOptions

          Options for CloudFormation template (like version, transform, description).

          -

          Readonlyregion

          region: string

          The AWS region into which this stack will be deployed (e.g. us-west-2).

          +

          Hierarchy

          • Stack
            • EmbeddedLinuxCodePipelineStack
          Index

          Constructors

          constructor +

          Properties

          tags +templateOptions +region +account +environment +nestedStackResource? +templateFile +artifactId +synthesizer +_versionReportingEnabled +_crossRegionReferences +_notificationArns? +node +

          Accessors

          terminationProtection +dependencies +stackName +partition +urlSuffix +stackId +notificationArns +nested +availabilityZones +nestedStackParent +bundlingRequired +

          Methods

          isStack +of +resolve +toJsonString +toYamlString +reportMissingContextKey +renameLogicalId +getLogicalId +addDependency +formatArn +splitArn +addTransform +addMetadata +_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate +regionalFact +exportValue +exportStringListValue +allocateLogicalId +_validateId +_toCloudFormation +isConstruct +toString +

          Constructors

          Properties

          tags: TagManager

          Tags to be applied to the stack.

          +
          templateOptions: ITemplateOptions

          Options for CloudFormation template (like version, transform, description).

          +
          region: string

          The AWS region into which this stack will be deployed (e.g. us-west-2).

          This value is resolved according to the following rules:

          1. The value provided to env.region when the stack is defined. This can @@ -69,7 +69,7 @@ into a region-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

            -

          Readonlyaccount

          account: string

          The AWS account into which this stack will be deployed.

          +
          account: string

          The AWS account into which this stack will be deployed.

          This value is resolved according to the following rules:

          1. The value provided to env.account when the stack is defined. This can @@ -83,10 +83,10 @@ check that it is a concrete value an not an unresolved token. If this value is an unresolved token (Token.isUnresolved(stack.account) returns true), this implies that the user wishes that this stack will synthesize -into a account-agnostic template. In this case, your code should either +into an account-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or -implement some other region-agnostic behavior.

            -

          Readonlyenvironment

          environment: string

          The environment coordinates in which this stack is deployed. In the form +implement some other account-agnostic behavior.

          +
          environment: string

          The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

          You can use this value to determine if two stacks are targeting the same @@ -95,21 +95,21 @@ Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

          -

          Optional ReadonlynestedStackResource

          nestedStackResource?: CfnResource

          If this is a nested stack, this represents its AWS::CloudFormation::Stack +

          nestedStackResource?: CfnResource

          If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

          -

          ReadonlytemplateFile

          templateFile: string

          The name of the CloudFormation template file emitted to the output +

          templateFile: string

          The name of the CloudFormation template file emitted to the output directory during synthesis.

          Example value: MyStack.template.json

          -

          ReadonlyartifactId

          artifactId: string

          The ID of the cloud assembly artifact for this stack.

          -

          Readonlysynthesizer

          synthesizer: IStackSynthesizer

          Synthesis method for this stack

          -

          Readonly Internal_versionReportingEnabled

          _versionReportingEnabled: boolean

          Whether version reporting is enabled for this stack

          +
          artifactId: string

          The ID of the cloud assembly artifact for this stack.

          +
          synthesizer: IStackSynthesizer

          Synthesis method for this stack

          +

          Readonly Internal_versionReportingEnabled

          _versionReportingEnabled: boolean

          Whether version reporting is enabled for this stack

          Controls whether the CDK Metadata resource is injected

          -

          Readonly Internal_crossRegionReferences

          _crossRegionReferences: boolean

          Whether cross region references are enabled for this stack

          -

          Optional Readonly Internal_notificationArns

          _notificationArns?: string[]

          SNS Notification ARNs to receive stack events.

          -

          Readonlynode

          node: Node

          The tree node.

          -

          Accessors

          terminationProtection

          • get terminationProtection(): boolean

            Whether termination protection is enabled for this stack.

            -

            Returns boolean

          • set terminationProtection(value: boolean): void

            Parameters

            • value: boolean

            Returns void

          dependencies

          • get dependencies(): Stack[]

            Return the stacks this stack depends on

            -

            Returns Stack[]

          stackName

          • get stackName(): string

            The concrete CloudFormation physical stack name.

            +

          Readonly Internal_crossRegionReferences

          _crossRegionReferences: boolean

          Whether cross region references are enabled for this stack

          +

          Optional Readonly Internal_notificationArns

          _notificationArns?: string[]

          SNS Notification ARNs to receive stack events.

          +
          node: Node

          The tree node.

          +

          Accessors

          • get terminationProtection(): boolean

            Whether termination protection is enabled for this stack.

            +

            Returns boolean

          • set terminationProtection(value: boolean): void

            Parameters

            • value: boolean

            Returns void

          • get dependencies(): Stack[]

            Return the stacks this stack depends on

            +

            Returns Stack[]

          • get stackName(): string

            The concrete CloudFormation physical stack name.

            This is either the name defined explicitly in the stackName prop or allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack @@ -117,15 +117,15 @@ scheme based on the construct path to ensure uniqueness.

            If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.

            -

            Returns string

          partition

          • get partition(): string

            The partition in which this stack is defined

            -

            Returns string

          urlSuffix

          • get urlSuffix(): string

            The Amazon domain suffix for the region in which this stack is defined

            -

            Returns string

          stackId

          • get stackId(): string

            The ID of the stack

            -

            Returns string

            Example

            // After resolving, looks like
            'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+

            Returns string

          • get partition(): string

            The partition in which this stack is defined

            +

            Returns string

          • get urlSuffix(): string

            The Amazon domain suffix for the region in which this stack is defined

            +

            Returns string

          • get stackId(): string

            The ID of the stack

            +

            Returns string

            // After resolving, looks like
            'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
            -

          notificationArns

          • get notificationArns(): string[]

            Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

            -

            Returns string[]

          nested

          • get nested(): boolean

            Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

            -

            Returns boolean

          availabilityZones

          • get availabilityZones(): string[]

            Returns the list of AZs that are available in the AWS environment +

          • get notificationArns(): string[]

            Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

            +

            Returns string[]

          • get nested(): boolean

            Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

            +

            Returns boolean

          • get availabilityZones(): string[]

            Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

            If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve @@ -135,23 +135,23 @@ reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

            To specify a different strategy for selecting availability zones override this method.

            -

            Returns string[]

          nestedStackParent

          • get nestedStackParent(): undefined | Stack

            If this is a nested stack, returns it's parent stack.

            -

            Returns undefined | Stack

          bundlingRequired

          • get bundlingRequired(): boolean

            Indicates whether the stack requires bundling or not

            -

            Returns boolean

          Methods

          StaticisStack

          • isStack(x: any): x is Stack

            Return whether the given object is a Stack.

            +

            Returns string[]

          • get nestedStackParent(): undefined | Stack

            If this is a nested stack, returns it's parent stack.

            +

            Returns undefined | Stack

          • get bundlingRequired(): boolean

            Indicates whether the stack requires bundling or not

            +

            Returns boolean

          Methods

          • Return whether the given object is a Stack.

            We do attribute detection since we can't reliably use 'instanceof'.

            -

            Parameters

            • x: any

            Returns x is Stack

          Staticof

          • of(construct: IConstruct): Stack

            Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

            +

            Parameters

            • this: void
            • x: any

            Returns x is Stack

          • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

            Parameters

            • construct: IConstruct

              The construct to start the search from.

              -

            Returns Stack

          resolve

          • resolve(obj: any): any

            Resolve a tokenized value in the context of the current stack.

            -

            Parameters

            • obj: any

            Returns any

          toJsonString

          • toJsonString(obj: any, space?: number): string

            Convert an object, potentially containing tokens, to a JSON string

            -

            Parameters

            • obj: any
            • Optionalspace: number

            Returns string

          toYamlString

          • toYamlString(obj: any): string

            Convert an object, potentially containing tokens, to a YAML string

            -

            Parameters

            • obj: any

            Returns string

          reportMissingContextKey

          • reportMissingContextKey(report: MissingContext): void

            Indicate that a context key was expected

            +

          Returns Stack

          • Resolve a tokenized value in the context of the current stack.

            +

            Parameters

            • obj: any

            Returns any

          • Convert an object, potentially containing tokens, to a JSON string

            +

            Parameters

            • this: void
            • obj: any
            • Optionalspace: number

            Returns string

          • Convert an object, potentially containing tokens, to a YAML string

            +

            Parameters

            • obj: any

            Returns string

          • Indicate that a context key was expected

            Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

            Parameters

            • report: MissingContext

              The set of parameters needed to obtain the context

              -

            Returns void

          renameLogicalId

          • renameLogicalId(oldId: string, newId: string): void

            Rename a generated logical identities

            +

          Returns void

          • Rename a generated logical identities

            To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

            -

            Parameters

            • oldId: string
            • newId: string

            Returns void

          getLogicalId

          • getLogicalId(element: CfnElement): string

            Allocates a stack-unique CloudFormation-compatible logical identity for a +

            Parameters

            • oldId: string
            • newId: string

            Returns void

          • Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.

            This method is called when a CfnElement is created and used to render the initial logical identity of resources. Logical ID renames are applied at @@ -161,10 +161,10 @@ class and override this method.

            Parameters

            • element: CfnElement

              The CloudFormation element for which a logical identity is needed.

              -

            Returns string

          addDependency

          • addDependency(target: Stack, reason?: string): void

            Add a dependency between this stack and another stack.

            +

          Returns string

          • Add a dependency between this stack and another stack.

            This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

            -

            Parameters

            • target: Stack
            • Optionalreason: string

            Returns void

          formatArn

          • formatArn(components: ArnComponents): string

            Creates an ARN from components.

            +

            Parameters

            • target: Stack
            • Optionalreason: string

            Returns void

          • Creates an ARN from components.

            If partition, region or account are not specified, the stack's partition, region and account will be used.

            If any component is the empty string, an empty string will be inserted @@ -174,37 +174,37 @@

            The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'.

            -

            Parameters

            • components: ArnComponents

            Returns string

          splitArn

          • splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

            Splits the provided ARN into its components. +

            Parameters

            • components: ArnComponents

            Returns string

          • Splits the provided ARN into its components. Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

            Parameters

            • arn: string

              the ARN to split into its components

            • arnFormat: ArnFormat

              the expected format of 'arn' - depends on what format the service 'arn' represents uses

              -

            Returns ArnComponents

          addTransform

          • addTransform(transform: string): void

            Add a Transform to this stack. A Transform is a macro that AWS +

          Returns ArnComponents

          Returns void

          https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

          +
          declare const stack: Stack;

          stack.addTransform('AWS::Serverless-2016-10-31')
          -

          addMetadata

          • addMetadata(key: string, value: any): void

            Adds an arbitrary key-value pair, with information you want to record about the stack. +

          _addAssemblyDependency

          _addAssemblyDependency

          • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
            Internal

            Called implicitly by the addDependency helper function in order to realize a dependency between two top-level stacks at the assembly level.

            Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

            -

            Parameters

            • target: Stack
            • Optionalreason: StackDependencyReason

            Returns void

          _obtainAssemblyDependencies

          • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
            Internal

            Called implicitly by the obtainDependencies helper function in order to +

            Parameters

            • target: Stack
            • Optionalreason: StackDependencyReason

            Returns void

          _obtainAssemblyDependencies

          • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
            Internal

            Called implicitly by the obtainDependencies helper function in order to collect resource dependencies across two top-level stacks at the assembly level.

            Use stack.obtainDependencies to see the dependencies between any two stacks.

            -

            Parameters

            • reasonFilter: StackDependencyReason

            Returns Element[]

          _removeAssemblyDependency

          • _removeAssemblyDependency(
                target: Stack,
                reasonFilter?: StackDependencyReason,
            ): void
            Internal

            Called implicitly by the removeDependency helper function in order to +

            Parameters

            • reasonFilter: StackDependencyReason

            Returns Element[]

          _removeAssemblyDependency

          • _removeAssemblyDependency(
                target: Stack,
                reasonFilter?: StackDependencyReason,
            ): void
            Internal

            Called implicitly by the removeDependency helper function in order to remove a dependency between two top-level stacks at the assembly level.

            Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

            -

            Parameters

            • target: Stack
            • OptionalreasonFilter: StackDependencyReason

            Returns void

          _synthesizeTemplate

          • _synthesizeTemplate(
                session: ISynthesisSession,
                lookupRoleArn?: string,
                lookupRoleExternalId?: string,
                lookupRoleAdditionalOptions?: { [key: string]: any },
            ): void
            Internal

            Synthesizes the cloudformation template into a cloud assembly.

            -

            Parameters

            • session: ISynthesisSession
            • OptionallookupRoleArn: string
            • OptionallookupRoleExternalId: string
            • OptionallookupRoleAdditionalOptions: { [key: string]: any }

            Returns void

          regionalFact

          • regionalFact(factName: string, defaultValue?: string): string

            Look up a fact value for the given fact for the region of this stack

            +

            Parameters

            • target: Stack
            • OptionalreasonFilter: StackDependencyReason

            Returns void

          _synthesizeTemplate

          • _synthesizeTemplate(
                session: ISynthesisSession,
                lookupRoleArn?: string,
                lookupRoleExternalId?: string,
                lookupRoleAdditionalOptions?: { [key: string]: any },
            ): void
            Internal

            Synthesizes the cloudformation template into a cloud assembly.

            +

            Parameters

            • session: ISynthesisSession
            • OptionallookupRoleArn: string
            • OptionallookupRoleExternalId: string
            • OptionallookupRoleAdditionalOptions: { [key: string]: any }

            Returns void

          • Look up a fact value for the given fact for the region of this stack

            Will return a definite value only if the region of the current stack is resolved. If not, a lookup map will be added to the stack and the lookup will be done at CDK deployment time.

            @@ -217,7 +217,7 @@ not have to worry about regional facts.

            If defaultValue is not given, it is an error if the fact is unknown for the given region.

            -

            Parameters

            • factName: string
            • OptionaldefaultValue: string

            Returns string

          exportValue

          • exportValue(exportedValue: any, options?: ExportValueOptions): string

            Create a CloudFormation Export for a string value

            +

            Parameters

            • factName: string
            • OptionaldefaultValue: string

            Returns string

          • Create a CloudFormation Export for a string value

            Returns a string representing the corresponding Fn.importValue() expression for this Export. You can control the name for the export by passing the name option.

            @@ -253,7 +253,7 @@
          • Don't forget to remove the exportValue() call as well.
          • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
          -

          Parameters

          • exportedValue: any
          • Optionaloptions: ExportValueOptions

          Returns string

          exportStringListValue

          • exportStringListValue(
                exportedValue: any,
                options?: ExportValueOptions,
            ): string[]

            Create a CloudFormation Export for a string list value

            +

            Parameters

            • exportedValue: any
            • Optionaloptions: ExportValueOptions

            Returns string

          • Create a CloudFormation Export for a string list value

            Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only @@ -268,7 +268,7 @@ remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

            See exportValue for an example of this process.

            -

            Parameters

            • exportedValue: any
            • Optionaloptions: ExportValueOptions

            Returns string[]

          ProtectedallocateLogicalId

          • allocateLogicalId(cfnElement: CfnElement): string

            Returns the naming scheme used to allocate logical IDs. By default, uses +

            Parameters

            • exportedValue: any
            • Optionaloptions: ExportValueOptions

            Returns string[]

          • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize this behavior.

            In order to make sure logical IDs are unique and stable, we hash the resource @@ -300,12 +300,12 @@ part of the identifier.

          Parameters

          • cfnElement: CfnElement

            The element for which the logical ID is allocated.

            -

          Returns string

          Protected_validateId

          • _validateId(name: string): void
            Internal

            Validate stack name

            +

          Returns string

          Protected_validateId

          • _validateId(name: string): void
            Internal

            Validate stack name

            CloudFormation stack names can include dashes in addition to the regular identifier character classes, and we don't allow one of the magic markers.

            -

            Parameters

            • name: string

            Returns void

          Protected_toCloudFormation

          • _toCloudFormation(): any
            Internal

            Returns the CloudFormation template for this stack by traversing +

            Parameters

            • name: string

            Returns void

          Protected_toCloudFormation

          • _toCloudFormation(): any
            Internal

            Returns the CloudFormation template for this stack by traversing the tree and invoking _toCloudFormation() on all Entity objects.

            -

            Returns any

          StaticisConstruct

          • isConstruct(x: any): x is Construct

            Checks if x is a construct.

            +

            Returns any

          • Checks if x is a construct.

            Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

            Explanation: in JavaScript, multiple copies of the constructs library on @@ -320,5 +320,5 @@ this type-testing method instead.

            Parameters

            • x: any

              Any object

            Returns x is Construct

            true if x is an object created from a class which extends Construct.

            -

          toString

          • toString(): string

            Returns a string representation of this construct.

            -

            Returns string

          Settings

          Member Visibility

          On This Page

          Constructors
          Properties
          Accessors
          Methods
          +

          • Returns a string representation of this construct.

            +

            Returns string

          Settings

          Member Visibility

          On This Page

          Constructors
          Properties
          Accessors
          Methods
          diff --git a/classes/PipelineResourcesStack.html b/classes/PipelineResourcesStack.html index e9afc54..0a724d2 100644 --- a/classes/PipelineResourcesStack.html +++ b/classes/PipelineResourcesStack.html @@ -1,71 +1,64 @@ -PipelineResourcesStack | aws4embeddedlinux-cdk-lib

          Class PipelineResourcesStack

          Input (Source) data for our PipelineResourcesStack.

          -

          Hierarchy

          • Stack
            • PipelineResourcesStack

          Constructors

          constructor -

          Properties

          vpc -ecrRepository -pipelineArtifactBucket -pipelineSourceBucket -pipelineOutputBucket -loggingBucket? -encryptionKey -tags -templateOptions -region -account -environment -nestedStackResource? -templateFile -artifactId -synthesizer -_versionReportingEnabled -_crossRegionReferences -_notificationArns? -node -

          Accessors

          terminationProtection -dependencies -stackName -partition -urlSuffix -stackId -notificationArns -nested -availabilityZones -nestedStackParent -bundlingRequired -

          Methods

          isStack -of -resolve -toJsonString -toYamlString -reportMissingContextKey -renameLogicalId -getLogicalId -addDependency -formatArn -splitArn -addTransform -addMetadata -_addAssemblyDependency -_obtainAssemblyDependencies -_removeAssemblyDependency -_synthesizeTemplate -regionalFact -exportValue -exportStringListValue -allocateLogicalId -_validateId -_toCloudFormation -isConstruct -toString -

          Constructors

          constructor

          Properties

          Readonlyvpc

          vpc: IVpc

          The VPC for the pipeline to reside in.

          -

          ReadonlyecrRepository

          ecrRepository: IRepository

          The respository to put the build host container in.

          -

          ReadonlypipelineArtifactBucket

          pipelineArtifactBucket: Bucket

          The artifact bucket

          -

          ReadonlypipelineSourceBucket

          pipelineSourceBucket: Bucket

          The source bucket

          -

          ReadonlypipelineOutputBucket

          pipelineOutputBucket: Bucket

          The output bucket

          -

          Optional ReadonlyloggingBucket

          loggingBucket?: Bucket

          The Cloudwatch logging bucket

          -

          ReadonlyencryptionKey

          encryptionKey: Key

          The encryption key use across

          -

          Readonlytags

          tags: TagManager

          Tags to be applied to the stack.

          -

          ReadonlytemplateOptions

          templateOptions: ITemplateOptions

          Options for CloudFormation template (like version, transform, description).

          -

          Readonlyregion

          region: string

          The AWS region into which this stack will be deployed (e.g. us-west-2).

          +PipelineResourcesStack | aws4embeddedlinux-cdk-lib
          aws4embeddedlinux-cdk-lib
            Preparing search index...

            Class PipelineResourcesStack

            Input (Source) data for our PipelineResourcesStack.

            +

            Hierarchy

            • Stack
              • PipelineResourcesStack
            Index

            Constructors

            constructor +

            Properties

            tags +templateOptions +region +account +environment +nestedStackResource? +templateFile +artifactId +synthesizer +_versionReportingEnabled +_crossRegionReferences +_notificationArns? +vpc +ecrRepository +pipelineArtifactBucket +pipelineSourceBucket +pipelineOutputBucket +loggingBucket? +encryptionKey +node +

            Accessors

            terminationProtection +dependencies +stackName +partition +urlSuffix +stackId +notificationArns +nested +availabilityZones +nestedStackParent +bundlingRequired +

            Methods

            isStack +of +resolve +toJsonString +toYamlString +reportMissingContextKey +renameLogicalId +getLogicalId +addDependency +formatArn +splitArn +addTransform +addMetadata +_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate +regionalFact +exportValue +exportStringListValue +allocateLogicalId +_validateId +_toCloudFormation +isConstruct +toString +

            Constructors

            Properties

            tags: TagManager

            Tags to be applied to the stack.

            +
            templateOptions: ITemplateOptions

            Options for CloudFormation template (like version, transform, description).

            +
            region: string

            The AWS region into which this stack will be deployed (e.g. us-west-2).

            This value is resolved according to the following rules:

            1. The value provided to env.region when the stack is defined. This can @@ -82,7 +75,7 @@ into a region-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

              -

            Readonlyaccount

            account: string

            The AWS account into which this stack will be deployed.

            +
            account: string

            The AWS account into which this stack will be deployed.

            This value is resolved according to the following rules:

            1. The value provided to env.account when the stack is defined. This can @@ -96,10 +89,10 @@ check that it is a concrete value an not an unresolved token. If this value is an unresolved token (Token.isUnresolved(stack.account) returns true), this implies that the user wishes that this stack will synthesize -into a account-agnostic template. In this case, your code should either +into an account-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or -implement some other region-agnostic behavior.

              -

            Readonlyenvironment

            environment: string

            The environment coordinates in which this stack is deployed. In the form +implement some other account-agnostic behavior.

            +
            environment: string

            The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

            You can use this value to determine if two stacks are targeting the same @@ -108,21 +101,28 @@ Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

            -

            Optional ReadonlynestedStackResource

            nestedStackResource?: CfnResource

            If this is a nested stack, this represents its AWS::CloudFormation::Stack +

            nestedStackResource?: CfnResource

            If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

            -

            ReadonlytemplateFile

            templateFile: string

            The name of the CloudFormation template file emitted to the output +

            templateFile: string

            The name of the CloudFormation template file emitted to the output directory during synthesis.

            Example value: MyStack.template.json

            -

            ReadonlyartifactId

            artifactId: string

            The ID of the cloud assembly artifact for this stack.

            -

            Readonlysynthesizer

            synthesizer: IStackSynthesizer

            Synthesis method for this stack

            -

            Readonly Internal_versionReportingEnabled

            _versionReportingEnabled: boolean

            Whether version reporting is enabled for this stack

            +
            artifactId: string

            The ID of the cloud assembly artifact for this stack.

            +
            synthesizer: IStackSynthesizer

            Synthesis method for this stack

            +

            Readonly Internal_versionReportingEnabled

            _versionReportingEnabled: boolean

            Whether version reporting is enabled for this stack

            Controls whether the CDK Metadata resource is injected

            -

            Readonly Internal_crossRegionReferences

            _crossRegionReferences: boolean

            Whether cross region references are enabled for this stack

            -

            Optional Readonly Internal_notificationArns

            _notificationArns?: string[]

            SNS Notification ARNs to receive stack events.

            -

            Readonlynode

            node: Node

            The tree node.

            -

            Accessors

            terminationProtection

            • get terminationProtection(): boolean

              Whether termination protection is enabled for this stack.

              -

              Returns boolean

            • set terminationProtection(value: boolean): void

              Parameters

              • value: boolean

              Returns void

            dependencies

            • get dependencies(): Stack[]

              Return the stacks this stack depends on

              -

              Returns Stack[]

            stackName

            • get stackName(): string

              The concrete CloudFormation physical stack name.

              +

            Readonly Internal_crossRegionReferences

            _crossRegionReferences: boolean

            Whether cross region references are enabled for this stack

            +

            Optional Readonly Internal_notificationArns

            _notificationArns?: string[]

            SNS Notification ARNs to receive stack events.

            +
            vpc: IVpc

            The VPC for the pipeline to reside in.

            +
            ecrRepository: IRepository

            The respository to put the build host container in.

            +
            pipelineArtifactBucket: Bucket

            The artifact bucket

            +
            pipelineSourceBucket: Bucket

            The source bucket

            +
            pipelineOutputBucket: Bucket

            The output bucket

            +
            loggingBucket?: Bucket

            The Cloudwatch logging bucket

            +
            encryptionKey: Key

            The encryption key use across

            +
            node: Node

            The tree node.

            +

            Accessors

            • get terminationProtection(): boolean

              Whether termination protection is enabled for this stack.

              +

              Returns boolean

            • set terminationProtection(value: boolean): void

              Parameters

              • value: boolean

              Returns void

            • get dependencies(): Stack[]

              Return the stacks this stack depends on

              +

              Returns Stack[]

            • get stackName(): string

              The concrete CloudFormation physical stack name.

              This is either the name defined explicitly in the stackName prop or allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack @@ -130,15 +130,15 @@ scheme based on the construct path to ensure uniqueness.

              If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.

              -

              Returns string

            partition

            • get partition(): string

              The partition in which this stack is defined

              -

              Returns string

            urlSuffix

            • get urlSuffix(): string

              The Amazon domain suffix for the region in which this stack is defined

              -

              Returns string

            stackId

            • get stackId(): string

              The ID of the stack

              -

              Returns string

              Example

              // After resolving, looks like
              'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
+

              Returns string

            • get partition(): string

              The partition in which this stack is defined

              +

              Returns string

            • get urlSuffix(): string

              The Amazon domain suffix for the region in which this stack is defined

              +

              Returns string

            • get stackId(): string

              The ID of the stack

              +

              Returns string

              // After resolving, looks like
              'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
              -

            notificationArns

            • get notificationArns(): string[]

              Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

              -

              Returns string[]

            nested

            • get nested(): boolean

              Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

              -

              Returns boolean

            availabilityZones

            • get availabilityZones(): string[]

              Returns the list of AZs that are available in the AWS environment +

            • get notificationArns(): string[]

              Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

              +

              Returns string[]

            • get nested(): boolean

              Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

              +

              Returns boolean

            • get availabilityZones(): string[]

              Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

              If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve @@ -148,23 +148,23 @@ reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

              To specify a different strategy for selecting availability zones override this method.

              -

              Returns string[]

            nestedStackParent

            • get nestedStackParent(): undefined | Stack

              If this is a nested stack, returns it's parent stack.

              -

              Returns undefined | Stack

            bundlingRequired

            • get bundlingRequired(): boolean

              Indicates whether the stack requires bundling or not

              -

              Returns boolean

            Methods

            StaticisStack

            • isStack(x: any): x is Stack

              Return whether the given object is a Stack.

              +

              Returns string[]

            • get nestedStackParent(): undefined | Stack

              If this is a nested stack, returns it's parent stack.

              +

              Returns undefined | Stack

            • get bundlingRequired(): boolean

              Indicates whether the stack requires bundling or not

              +

              Returns boolean

            Methods

            • Return whether the given object is a Stack.

              We do attribute detection since we can't reliably use 'instanceof'.

              -

              Parameters

              • x: any

              Returns x is Stack

            Staticof

            • of(construct: IConstruct): Stack

              Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

              +

              Parameters

              • this: void
              • x: any

              Returns x is Stack

            • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

              Parameters

              • construct: IConstruct

                The construct to start the search from.

                -

              Returns Stack

            resolve

            • resolve(obj: any): any

              Resolve a tokenized value in the context of the current stack.

              -

              Parameters

              • obj: any

              Returns any

            toJsonString

            • toJsonString(obj: any, space?: number): string

              Convert an object, potentially containing tokens, to a JSON string

              -

              Parameters

              • obj: any
              • Optionalspace: number

              Returns string

            toYamlString

            • toYamlString(obj: any): string

              Convert an object, potentially containing tokens, to a YAML string

              -

              Parameters

              • obj: any

              Returns string

            reportMissingContextKey

            • reportMissingContextKey(report: MissingContext): void

              Indicate that a context key was expected

              +

            Returns Stack

            • Resolve a tokenized value in the context of the current stack.

              +

              Parameters

              • obj: any

              Returns any

            • Convert an object, potentially containing tokens, to a JSON string

              +

              Parameters

              • this: void
              • obj: any
              • Optionalspace: number

              Returns string

            • Convert an object, potentially containing tokens, to a YAML string

              +

              Parameters

              • obj: any

              Returns string

            • Indicate that a context key was expected

              Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

              Parameters

              • report: MissingContext

                The set of parameters needed to obtain the context

                -

              Returns void

            renameLogicalId

            • renameLogicalId(oldId: string, newId: string): void

              Rename a generated logical identities

              +

            Returns void

            • Rename a generated logical identities

              To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

              -

              Parameters

              • oldId: string
              • newId: string

              Returns void

            getLogicalId

            • getLogicalId(element: CfnElement): string

              Allocates a stack-unique CloudFormation-compatible logical identity for a +

              Parameters

              • oldId: string
              • newId: string

              Returns void

            • Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.

              This method is called when a CfnElement is created and used to render the initial logical identity of resources. Logical ID renames are applied at @@ -174,10 +174,10 @@ class and override this method.

              Parameters

              • element: CfnElement

                The CloudFormation element for which a logical identity is needed.

                -

              Returns string

            addDependency

            • addDependency(target: Stack, reason?: string): void

              Add a dependency between this stack and another stack.

              +

            Returns string

            • Add a dependency between this stack and another stack.

              This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

              -

              Parameters

              • target: Stack
              • Optionalreason: string

              Returns void

            formatArn

            • formatArn(components: ArnComponents): string

              Creates an ARN from components.

              +

              Parameters

              • target: Stack
              • Optionalreason: string

              Returns void

            • Creates an ARN from components.

              If partition, region or account are not specified, the stack's partition, region and account will be used.

              If any component is the empty string, an empty string will be inserted @@ -187,37 +187,37 @@

              The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'.

              -

              Parameters

              • components: ArnComponents

              Returns string

            splitArn

            • splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

              Splits the provided ARN into its components. +

              Parameters

              • components: ArnComponents

              Returns string

            • Splits the provided ARN into its components. Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

              Parameters

              • arn: string

                the ARN to split into its components

              • arnFormat: ArnFormat

                the expected format of 'arn' - depends on what format the service 'arn' represents uses

                -

              Returns ArnComponents

            addTransform

            • addTransform(transform: string): void

              Add a Transform to this stack. A Transform is a macro that AWS +

            Returns ArnComponents

            Returns void

            https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

            +
            declare const stack: Stack;

            stack.addTransform('AWS::Serverless-2016-10-31')
            -

            addMetadata

            • addMetadata(key: string, value: any): void

              Adds an arbitrary key-value pair, with information you want to record about the stack. +

            _addAssemblyDependency

            _addAssemblyDependency

            • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
              Internal

              Called implicitly by the addDependency helper function in order to realize a dependency between two top-level stacks at the assembly level.

              Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

              -

              Parameters

              • target: Stack
              • Optionalreason: StackDependencyReason

              Returns void

            _obtainAssemblyDependencies

            • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
              Internal

              Called implicitly by the obtainDependencies helper function in order to +

              Parameters

              • target: Stack
              • Optionalreason: StackDependencyReason

              Returns void

            _obtainAssemblyDependencies

            • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
              Internal

              Called implicitly by the obtainDependencies helper function in order to collect resource dependencies across two top-level stacks at the assembly level.

              Use stack.obtainDependencies to see the dependencies between any two stacks.

              -

              Parameters

              • reasonFilter: StackDependencyReason

              Returns Element[]

            _removeAssemblyDependency

            • _removeAssemblyDependency(
                  target: Stack,
                  reasonFilter?: StackDependencyReason,
              ): void
              Internal

              Called implicitly by the removeDependency helper function in order to +

              Parameters

              • reasonFilter: StackDependencyReason

              Returns Element[]

            _removeAssemblyDependency

            • _removeAssemblyDependency(
                  target: Stack,
                  reasonFilter?: StackDependencyReason,
              ): void
              Internal

              Called implicitly by the removeDependency helper function in order to remove a dependency between two top-level stacks at the assembly level.

              Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

              -

              Parameters

              • target: Stack
              • OptionalreasonFilter: StackDependencyReason

              Returns void

            _synthesizeTemplate

            • _synthesizeTemplate(
                  session: ISynthesisSession,
                  lookupRoleArn?: string,
                  lookupRoleExternalId?: string,
                  lookupRoleAdditionalOptions?: { [key: string]: any },
              ): void
              Internal

              Synthesizes the cloudformation template into a cloud assembly.

              -

              Parameters

              • session: ISynthesisSession
              • OptionallookupRoleArn: string
              • OptionallookupRoleExternalId: string
              • OptionallookupRoleAdditionalOptions: { [key: string]: any }

              Returns void

            regionalFact

            • regionalFact(factName: string, defaultValue?: string): string

              Look up a fact value for the given fact for the region of this stack

              +

              Parameters

              • target: Stack
              • OptionalreasonFilter: StackDependencyReason

              Returns void

            _synthesizeTemplate

            • _synthesizeTemplate(
                  session: ISynthesisSession,
                  lookupRoleArn?: string,
                  lookupRoleExternalId?: string,
                  lookupRoleAdditionalOptions?: { [key: string]: any },
              ): void
              Internal

              Synthesizes the cloudformation template into a cloud assembly.

              +

              Parameters

              • session: ISynthesisSession
              • OptionallookupRoleArn: string
              • OptionallookupRoleExternalId: string
              • OptionallookupRoleAdditionalOptions: { [key: string]: any }

              Returns void

            • Look up a fact value for the given fact for the region of this stack

              Will return a definite value only if the region of the current stack is resolved. If not, a lookup map will be added to the stack and the lookup will be done at CDK deployment time.

              @@ -230,7 +230,7 @@ not have to worry about regional facts.

              If defaultValue is not given, it is an error if the fact is unknown for the given region.

              -

              Parameters

              • factName: string
              • OptionaldefaultValue: string

              Returns string

            exportValue

            • exportValue(exportedValue: any, options?: ExportValueOptions): string

              Create a CloudFormation Export for a string value

              +

              Parameters

              • factName: string
              • OptionaldefaultValue: string

              Returns string

            • Create a CloudFormation Export for a string value

              Returns a string representing the corresponding Fn.importValue() expression for this Export. You can control the name for the export by passing the name option.

              @@ -266,7 +266,7 @@
            • Don't forget to remove the exportValue() call as well.
            • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
            -

            Parameters

            • exportedValue: any
            • Optionaloptions: ExportValueOptions

            Returns string

            exportStringListValue

            • exportStringListValue(
                  exportedValue: any,
                  options?: ExportValueOptions,
              ): string[]

              Create a CloudFormation Export for a string list value

              +

              Parameters

              • exportedValue: any
              • Optionaloptions: ExportValueOptions

              Returns string

            • Create a CloudFormation Export for a string list value

              Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only @@ -281,7 +281,7 @@ remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

              See exportValue for an example of this process.

              -

              Parameters

              • exportedValue: any
              • Optionaloptions: ExportValueOptions

              Returns string[]

            ProtectedallocateLogicalId

            • allocateLogicalId(cfnElement: CfnElement): string

              Returns the naming scheme used to allocate logical IDs. By default, uses +

              Parameters

              • exportedValue: any
              • Optionaloptions: ExportValueOptions

              Returns string[]

            • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize this behavior.

              In order to make sure logical IDs are unique and stable, we hash the resource @@ -313,12 +313,12 @@ part of the identifier.

            Parameters

            • cfnElement: CfnElement

              The element for which the logical ID is allocated.

              -

            Returns string

            Protected_validateId

            • _validateId(name: string): void
              Internal

              Validate stack name

              +

            Returns string

            Protected_validateId

            • _validateId(name: string): void
              Internal

              Validate stack name

              CloudFormation stack names can include dashes in addition to the regular identifier character classes, and we don't allow one of the magic markers.

              -

              Parameters

              • name: string

              Returns void

            Protected_toCloudFormation

            • _toCloudFormation(): any
              Internal

              Returns the CloudFormation template for this stack by traversing +

              Parameters

              • name: string

              Returns void

            Protected_toCloudFormation

            • _toCloudFormation(): any
              Internal

              Returns the CloudFormation template for this stack by traversing the tree and invoking _toCloudFormation() on all Entity objects.

              -

              Returns any

            StaticisConstruct

            • isConstruct(x: any): x is Construct

              Checks if x is a construct.

              +

              Returns any

            • Checks if x is a construct.

              Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

              Explanation: in JavaScript, multiple copies of the constructs library on @@ -333,5 +333,5 @@ this type-testing method instead.

              Parameters

              • x: any

                Any object

              Returns x is Construct

              true if x is an object created from a class which extends Construct.

              -

            toString

            • toString(): string

              Returns a string representation of this construct.

              -

              Returns string

            Settings

            Member Visibility

            On This Page

            Constructors
            Properties
            Accessors
            Methods
            +

            • Returns a string representation of this construct.

              +

              Returns string

            Settings

            Member Visibility

            On This Page

            Constructors
            Properties
            Accessors
            Methods
            diff --git a/enums/ProjectType.html b/enums/ProjectType.html index 3025509..252d9aa 100644 --- a/enums/ProjectType.html +++ b/enums/ProjectType.html @@ -1,18 +1,18 @@ -ProjectType | aws4embeddedlinux-cdk-lib

            Enumeration ProjectType

            The type of project built.

            -

            Enumeration Members

            Poky -QEmu -PokyAmi -Kas -Renesas -NxpImx -CodeBuild -Custom -

            Enumeration Members

            Poky

            Poky: "poky"

            Build core-image-minimal from poky.

            -

            QEmu

            QEmu: "qemu"

            Build the Qemu meta-aws Demonstration Distribution.

            -

            PokyAmi

            PokyAmi: "poky-ami"

            Build an EC2 AMI

            -

            Kas

            Kas: "kas"

            Build an kas based image

            -

            Renesas

            Renesas: "renesas"

            Build an Renesas image

            -

            NxpImx

            NxpImx: "nxp-imx"

            Build an IMX image using NXP layers.

            -

            CodeBuild

            CodeBuild: "codebuild"

            Build no pipeline, just CodeBuild project to connect with GitHub actions.

            -

            Custom

            Custom: "custom"

            Build an image using a custom buildspec and asstes.

            -

            Settings

            Member Visibility

            On This Page

            Enumeration Members
            +ProjectType | aws4embeddedlinux-cdk-lib
            aws4embeddedlinux-cdk-lib
              Preparing search index...

              Enumeration ProjectType

              The type of project built.

              +
              Index

              Enumeration Members

              Poky +QEmu +PokyAmi +Kas +Renesas +NxpImx +CodeBuild +Custom +

              Enumeration Members

              Poky: "poky"

              Build core-image-minimal from poky.

              +
              QEmu: "qemu"

              Build the Qemu meta-aws Demonstration Distribution.

              +
              PokyAmi: "poky-ami"

              Build an EC2 AMI

              +
              Kas: "kas"

              Build an kas based image

              +
              Renesas: "renesas"

              Build an Renesas image

              +
              NxpImx: "nxp-imx"

              Build an IMX image using NXP layers.

              +
              CodeBuild: "codebuild"

              Build no pipeline, just CodeBuild project to connect with GitHub actions.

              +
              Custom: "custom"

              Build an image using a custom buildspec and asstes.

              +

              Settings

              Member Visibility

              On This Page

              Enumeration Members
              diff --git a/hierarchy.html b/hierarchy.html new file mode 100644 index 0000000..c88d3a2 --- /dev/null +++ b/hierarchy.html @@ -0,0 +1 @@ +aws4embeddedlinux-cdk-lib
              aws4embeddedlinux-cdk-lib
                Preparing search index...

                aws4embeddedlinux-cdk-lib

                Hierarchy Summary

                Settings

                Member Visibility
                diff --git a/index.html b/index.html index 1ffb122..cab68dd 100644 --- a/index.html +++ b/index.html @@ -1,5 +1,5 @@ -aws4embeddedlinux-cdk-lib

                aws4embeddedlinux-cdk-lib

                aws4embeddedlinux-ci

                The aws4embeddedlinux-ci library helps you deploy an AWS cloud infrastructure supporting the Embedded Linux builds for your project using AWS CDK.

                -

                Table of Contents

                  +aws4embeddedlinux-cdk-lib
                  aws4embeddedlinux-cdk-lib
                    Preparing search index...

                    aws4embeddedlinux-cdk-lib

                    aws4embeddedlinux-ci

                    The aws4embeddedlinux-ci library helps you deploy an AWS cloud infrastructure supporting the Embedded Linux builds for your project using AWS CDK.

                    +
                    1. Architecture
                    2. API documentation
                    3. Project Build with AWS CodePipeline
                      4. @@ -11,30 +11,30 @@
                    4. Contributing
                    5. License
                    -

                    Architecture

                    This is the overall architecture pattern used to deploy the build pipeline:

                    +

                    This is the overall architecture pattern used to deploy the build pipeline:

                    architecture overview

                    Bask to the top

                    -

                    API documentation

                    The API documentation is generated automatically using Typedoc.

                    +

                    The API documentation is generated automatically using Typedoc.

                    Bask to the top

                    -

                    Project Build with AWS CodePipeline

                    Several pipelines are provided in this library, each one demonstrating a different aspect of how to build a Yocto image with AWS.

                    +

                    Several pipelines are provided in this library, each one demonstrating a different aspect of how to build a Yocto image with AWS.

                    Once deployed, ou can review the pipeline execution from the Developer Tools > Pipeline - CodePipeline > Pipelines page in the AWS Console.

                    From the pipeline page, you can find the source repository (S3), the CodeBuild Project (with the build logs), and the S3 bucket that the image is uploaded to, at the end.

                    Each pipelines will refresh/re-run automatically every week using AWS EventBridge in order to grab the latest updates.

                    -

                    Poky

                    The pipeline name will end with poky.

                    +

                    The pipeline name will end with poky.

                    This example will build the core-image-minimal image from Poky using the repo tool to manage layers. CVE checking is also enabled in the buildspec file.

                    Expected build times:

                    • First build: 32 minutes
                    • Rebuild (without any change, just use sstate cache): 8 minutes
                    -

                    Poky EC2 AMI

                    The pipeline name will end with poky-ami.

                    +

                    The pipeline name will end with poky-ami.

                    Yocto can be used to create an EC2 AMI. This example builds an AMI based on Poky and meta-aws and exports it to your AMI registry using the VM Import/Export Service.

                    Expected build times:

                    • First build: 52 minutes
                    • Rebuild (without any change, just use sstate cache): 17 minutes
                    -

                    Kas

                    The pipeline name will end with kas.

                    +

                    The pipeline name will end with kas.

                    The Kas example shows how to use a Kas Config to manage layers.

                    This tool can help programatically manage layers and config with tighter Yocto integration than Git Submodules or the Repo tool.

                    Expected build times:

                    @@ -42,7 +42,7 @@
                  • First build: 36 minutes
                  • Rebuild (without any change, just use sstate cache): 11 minutes
                    • -

                    QEmu

                    The pipeline name will end with qemu.

                    +

                    The pipeline name will end with qemu.

                    This example builds a Qemu based image using meta-aws-demos.

                    The Qemu image can be run in the CodeBuild environment. Using SLIRP networking, OEQA testing such as ptest can be run in the pipeline.

                    Expected build times:

                    @@ -50,7 +50,7 @@
                  • First build: 45 minutes
                  • Rebuild (without any change, just use sstate cache): 14 minutes
                    • -

                    NXP / IMX

                    The pipeline name will end with nxp.

                    +

                    NXP / IMX

                    The pipeline name will end with nxp.

                    This example will build an image for the i.MX 6ULL EVK board.

                    NXP requires users to accept and comply with a EULA in order to build and, for this reason, the buildspec will require modification before the build succeeds.

                    See the IMX Yocto Users Guide for more detail.

                    @@ -59,7 +59,7 @@
                  • First build: xx minutes
                  • Rebuild (without any change, just use sstate cache): xx minutes
                    • -

                    Renesas

                    This example is based on the Yocto / Renesas R-Car work to build an image for Renesas R-Car-H3 Starter Kit Premier board (unofficial name - H3ULCB) including the proprietary graphics and multimedia drivers from Renesas.

                    +

                    This example is based on the Yocto / Renesas R-Car work to build an image for Renesas R-Car-H3 Starter Kit Premier board (unofficial name - H3ULCB) including the proprietary graphics and multimedia drivers from Renesas.

                    You will need to download the Multimedia and Graphics library and related Linux drivers from the following link (registration necessary):

                    Bask to the top

                    -

                    Project Build with AWS CodeBuild as Action Runner

                    This will create an AWS CodeBuild project ready to build Embedded Linux which can be used to connect to an external source, e.g. GitHub Actions. This is not using any AWS CodePipeline as in the the Pipeline examples section.

                    +

                    This will create an AWS CodeBuild project ready to build Embedded Linux which can be used to connect to an external source, e.g. GitHub Actions. This is not using any AWS CodePipeline as in the the Pipeline examples section.

                    You can use the following example for your GitHub Action.

                    We recommend you to clone the created AWS CodeBuild project and then proceed with the GitHub Action configuration. However, this will result in the use of the same EFS file system across projects.

                    @@ -110,7 +110,7 @@ There might be more than one occuerence to replace in the file.

                    Refer to the following example for more details.

                    Bask to the top

                    -

                    Setup

                    In order to use this library, you must first set up an AWS CDK project, including +

                    In order to use this library, you must first set up an AWS CDK project, including installing the CDK tool and bootstrapping the account you wish to deploy to.

                    Additionally, you must have NodeJS installed.

                    Note

                    @@ -118,7 +118,7 @@

                    You can also use the sample project code provided to get started and deploy the stacks.

                    Bask to the top

                    -

                    Setting Up A New Project

                    In order to create a new project, you will need to initialize a new CDK project.

                    +

                    In order to create a new project, you will need to initialize a new CDK project.

                    More details can be found in the CDK Getting Started Documentation.

                    The following commands will create a new CDK project named my-project:

                    mkdir my-project
                    cd my-project
                    cdk init app --language typescript
@@ -164,7 +164,7 @@

                    Once your pipelines completes successfully, the Yocto deploy directory generated content will be pushed into a S3 bucket.

                    Bask to the top

                    -

                    Development Setup

                    The repository is leveraging Yarn 2 and if you are not familliar with Yarn, please refer to the documentation.

                    +

                    The repository is leveraging Yarn 2 and if you are not familliar with Yarn, please refer to the documentation.

                    If you are looking to develop new feature, you can use yarn link to develop with a local copy of this repo.

                    In this library repo, execute the following:

                    yarn install
                    yarn run build
                    yarn link
@@ -188,7 +188,7 @@
 
                    When using a system node install on Linux, this can require sudo access.
 To avoid this, use a node version manager or set a node prefix.
                    
 
-
                    Using Git Credentials and Build Time Secrets
                    AWS Secrets Manager is the preferred method for adding and using secrets in your pipelines.
                    
+
                    AWS Secrets Manager is the preferred method for adding and using secrets in your pipelines.
                    
 
                    The service provides a structured means of access and avoids the pitfalls of putting secrets in environment variables, source repos, etc.
                    
 
                    The following steps detaisl at a high level, how you can enable the use of AWS Secrets Manager in your pipelines:
                    
 
                      
@@ -215,19 +215,19 @@
 
 
                    
 
                    See the CodeBuild Documentation for more details.
                    
-
                    CVE Checking With Yocto
                    CVE checking is enabled in the reference implementations. Details on this can be found in the Yocto documentation.
                    
+
                    CVE checking is enabled in the reference implementations. Details on this can be found in the Yocto documentation.
                    
 
                    Bask to the top
                    
-
                    Known issues
                      
+
                        
 
                      • The use of this CDK library is currently not supported in Windows environments (you can still use WSL).
                        • 
 
                      • When using AWS Cloud9, a micro instance type will run out of memory.
                        • 
 
                      • Deletion of stacks while a CodePipeline is running can lead to unexpected behaviours.
                        • 
 
                      • The NXP-IMX pipeline will fail unless you adjust the build spec file and address the licence acceptance requirement.
                        • 
 
                      
 
                      Bask to the top
                      
-
                      Security
                      See SECURITY for more information about reporting issues with this project.
                      
+
                      See SECURITY for more information about reporting issues with this project.
                      
 
                      Bask to the top
                      
-
                      Contributing
                      See CONTRIBUTING for more information.
                      
+
                      See CONTRIBUTING for more information.
                      
 
                      Bask to the top
                      
-
                      License
                      This library is licensed under the MIT-0 License. See the LICENSE file.
                      
+
                      This library is licensed under the MIT-0 License. See the LICENSE file.
                      
 
                      Bask to the top
                      
-

                    Settings

                    Member Visibility

                    On This Page

                    aws4embeddedlinux-ci
                  +

                  Settings

                  Member Visibility

                  On This Page

                  aws4embeddedlinux-ci
                  diff --git a/interfaces/EmbeddedLinuxCodeBuildProjectProps.html b/interfaces/EmbeddedLinuxCodeBuildProjectProps.html index 2479453..b3fd484 100644 --- a/interfaces/EmbeddedLinuxCodeBuildProjectProps.html +++ b/interfaces/EmbeddedLinuxCodeBuildProjectProps.html @@ -1,30 +1,25 @@ -EmbeddedLinuxCodeBuildProjectProps | aws4embeddedlinux-cdk-lib

                  Interface EmbeddedLinuxCodeBuildProjectProps

                  Properties to allow customizing the build.

                  -
                  interface EmbeddedLinuxCodeBuildProjectProps {
                      ecrRepository: IRepository;
                      ecrRepositoryImageTag: string;
                      vpc: IVpc;
                      buildPolicyAdditions?: PolicyStatement[];
                      encryptionKey: Key;
                      description?: string;
                      env?: Environment;
                      stackName?: string;
                      tags?: { [key: string]: string };
                      notificationArns?: string[];
                      synthesizer?: IStackSynthesizer;
                      terminationProtection?: boolean;
                      analyticsReporting?: boolean;
                      crossRegionReferences?: boolean;
                      permissionsBoundary?: PermissionsBoundary;
                      suppressTemplateIndentation?: boolean;
                  }

                  Hierarchy

                  • StackProps
                    • EmbeddedLinuxCodeBuildProjectProps

                  Properties

                  ecrRepository -ecrRepositoryImageTag -vpc -buildPolicyAdditions? -encryptionKey -description? -env? -stackName? -tags? -notificationArns? -synthesizer? -terminationProtection? -analyticsReporting? -crossRegionReferences? -permissionsBoundary? -suppressTemplateIndentation? -

                  Properties

                  ReadonlyecrRepository

                  ecrRepository: IRepository

                  ECR Repository where the Build Host Image resides.

                  -

                  ReadonlyecrRepositoryImageTag

                  ecrRepositoryImageTag: string

                  Tag for the Build Host Image

                  -

                  Readonlyvpc

                  vpc: IVpc

                  VPC where the networking setup resides.

                  -

                  Optional ReadonlybuildPolicyAdditions

                  buildPolicyAdditions?: PolicyStatement[]

                  Additional policy statements to add to the build project.

                  -

                  ReadonlyencryptionKey

                  encryptionKey: Key

                  The encryption key use across

                  -

                  Optional Readonlydescription

                  description?: string

                  A description of the stack.

                  -

                  Default

                  - No description.
+EmbeddedLinuxCodeBuildProjectProps | aws4embeddedlinux-cdk-lib
                  aws4embeddedlinux-cdk-lib
                    Preparing search index...
                    Interface EmbeddedLinuxCodeBuildProjectProps
                    Properties to allow customizing the build.
                    
+
                    interface EmbeddedLinuxCodeBuildProjectProps {
                        description?: string;
                        env?: Environment;
                        stackName?: string;
                        tags?: { [key: string]: string };
                        notificationArns?: string[];
                        synthesizer?: IStackSynthesizer;
                        terminationProtection?: boolean;
                        analyticsReporting?: boolean;
                        crossRegionReferences?: boolean;
                        permissionsBoundary?: PermissionsBoundary;
                        suppressTemplateIndentation?: boolean;
                        ecrRepository: IRepository;
                        ecrRepositoryImageTag: string;
                        vpc: IVpc;
                        buildPolicyAdditions?: PolicyStatement[];
                        encryptionKey: Key;
                    }
                    Hierarchy
                    • StackProps
                      • EmbeddedLinuxCodeBuildProjectProps
                    Index
                    Properties
                    description?
+env?
+stackName?
+tags?
+notificationArns?
+synthesizer?
+terminationProtection?
+analyticsReporting?
+crossRegionReferences?
+permissionsBoundary?
+suppressTemplateIndentation?
+ecrRepository
+ecrRepositoryImageTag
+vpc
+buildPolicyAdditions?
+encryptionKey
+
                    Properties
                    description?: string
                    A description of the stack.
                    
+
                    - No description.
 
                    
 
-
                    Optional Readonlyenv
                    env?: Environment
                    The AWS environment (account/region) where this stack will be deployed.
                    
+
                    env?: Environment

                    The AWS environment (account/region) where this stack will be deployed.

                    Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables @@ -41,26 +36,26 @@ use environmental context lookups such as ec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements.

                    -

                    Example

                    // Use a concrete account and region to deploy this stack to:
                    // `.account` and `.region` will simply return these values.
                    new Stack(app, 'Stack1', {
                      env: {
                        account: '123456789012',
                        region: 'us-east-1'
                      },
                    });

                    // Use the CLI's current credentials to determine the target environment:
                    // `.account` and `.region` will reflect the account+region the CLI
                    // is configured to use (based on the user CLI credentials)
                    new Stack(app, 'Stack2', {
                      env: {
                        account: process.env.CDK_DEFAULT_ACCOUNT,
                        region: process.env.CDK_DEFAULT_REGION
                      },
                    });

                    // Define multiple stacks stage associated with an environment
                    const myStage = new Stage(app, 'MyStage', {
                      env: {
                        account: '123456789012',
                        region: 'us-east-1'
                      }
                    });

                    // both of these stacks will use the stage's account/region:
                    // `.account` and `.region` will resolve to the concrete values as above
                    new MyStack(myStage, 'Stack1');
                    new YourStack(myStage, 'Stack2');

                    // Define an environment-agnostic stack:
                    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
                    // which will only resolve to actual values by CloudFormation during deployment.
                    new MyStack(app, 'Stack1');
+
                    // Use a concrete account and region to deploy this stack to:
                    // `.account` and `.region` will simply return these values.
                    new Stack(app, 'Stack1', {
                      env: {
                        account: '123456789012',
                        region: 'us-east-1'
                      },
                    });

                    // Use the CLI's current credentials to determine the target environment:
                    // `.account` and `.region` will reflect the account+region the CLI
                    // is configured to use (based on the user CLI credentials)
                    new Stack(app, 'Stack2', {
                      env: {
                        account: process.env.CDK_DEFAULT_ACCOUNT,
                        region: process.env.CDK_DEFAULT_REGION
                      },
                    });

                    // Define multiple stacks stage associated with an environment
                    const myStage = new Stage(app, 'MyStage', {
                      env: {
                        account: '123456789012',
                        region: 'us-east-1'
                      }
                    });

                    // both of these stacks will use the stage's account/region:
                    // `.account` and `.region` will resolve to the concrete values as above
                    new MyStack(myStage, 'Stack1');
                    new YourStack(myStage, 'Stack2');

                    // Define an environment-agnostic stack:
                    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
                    // which will only resolve to actual values by CloudFormation during deployment.
                    new MyStack(app, 'Stack1');
                    -

                    Default

                      +
                    • The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
                    -

                    Optional ReadonlystackName

                    stackName?: string

                    Name to deploy the stack with

                    -

                    Default

                    - Derived from construct path.
+
                    stackName?: string

                    Name to deploy the stack with

                    +
                    - Derived from construct path.
                    -

                    Optional Readonlytags

                    tags?: { [key: string]: string }

                    Stack tags that will be applied to all the taggable resources and the stack itself.

                    -

                    Default

                    {}
+
                    tags?: { [key: string]: string }

                    Stack tags that will be applied to all the taggable resources and the stack itself.

                    +
                    {}
                    -

                    Optional ReadonlynotificationArns

                    notificationArns?: string[]

                    SNS Topic ARNs that will receive stack events.

                    -

                    Default

                    - no notfication arns.
+
                    notificationArns?: string[]

                    SNS Topic ARNs that will receive stack events.

                    +
                    - no notfication arns.
                    -

                    Optional Readonlysynthesizer

                    synthesizer?: IStackSynthesizer

                    Synthesis method to use while deploying this stack

                    +
                    synthesizer?: IStackSynthesizer

                    Synthesis method to use while deploying this stack

                    The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

                    @@ -69,34 +64,39 @@ @aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.

                    -

                    Default

                      +
                    • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
                    -

                    Optional ReadonlyterminationProtection

                    terminationProtection?: boolean

                    Whether to enable termination protection for this stack.

                    -

                    Default

                    false
+
                    terminationProtection?: boolean

                    Whether to enable termination protection for this stack.

                    +
                    false
                    -

                    Optional ReadonlyanalyticsReporting

                    analyticsReporting?: boolean

                    Include runtime versioning information in this Stack

                    -

                    Default

                    analyticsReporting setting of containing App, or value of +

                    analyticsReporting?: boolean

                    Include runtime versioning information in this Stack

                    +

                    analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key

                    -

                    Optional ReadonlycrossRegionReferences

                    crossRegionReferences?: boolean

                    Enable this flag to allow native cross region stack references.

                    +
                    crossRegionReferences?: boolean

                    Enable this flag to allow native cross region stack references.

                    Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

                    This feature is currently experimental

                    -

                    Default

                    false
+
                    false
                    -

                    Optional ReadonlypermissionsBoundary

                    permissionsBoundary?: PermissionsBoundary

                    Options for applying a permissions boundary to all IAM Roles +

                    permissionsBoundary?: PermissionsBoundary

                    Options for applying a permissions boundary to all IAM Roles and Users created within this Stage

                    -

                    Default

                    - no permissions boundary is applied
+
                    - no permissions boundary is applied
                    -

                    Optional ReadonlysuppressTemplateIndentation

                    suppressTemplateIndentation?: boolean

                    Enable this flag to suppress indentation in generated +

                    suppressTemplateIndentation?: boolean

                    Enable this flag to suppress indentation in generated CloudFormation templates.

                    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used.

                    -

                    Default

                      +
                    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                    -

                    Settings

                    Member Visibility

                    On This Page

                    Properties
                    +
                    ecrRepository: IRepository

                    ECR Repository where the Build Host Image resides.

                    +
                    ecrRepositoryImageTag: string

                    Tag for the Build Host Image

                    +
                    vpc: IVpc

                    VPC where the networking setup resides.

                    +
                    buildPolicyAdditions?: PolicyStatement[]

                    Additional policy statements to add to the build project.

                    +
                    encryptionKey: Key

                    The encryption key use across

                    +

                    Settings

                    Member Visibility

                    On This Page

                    Properties
                    diff --git a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html index 07ab314..8bf2275 100644 --- a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html @@ -1,30 +1,25 @@ -EmbeddedLinuxCodePipelineBaseImageProps | aws4embeddedlinux-cdk-lib

                    Interface EmbeddedLinuxCodePipelineBaseImageProps

                    Select options for the BuildImageCodePipelineStack.

                    -
                    interface EmbeddedLinuxCodePipelineBaseImageProps {
                        pipelineSourceBucket: IBucket;
                        pipelineSourcePrefix?: string;
                        pipelineArtifactBucket: Bucket;
                        ecrRepository: IRepository;
                        encryptionKey: Key;
                        description?: string;
                        env?: Environment;
                        stackName?: string;
                        tags?: { [key: string]: string };
                        notificationArns?: string[];
                        synthesizer?: IStackSynthesizer;
                        terminationProtection?: boolean;
                        analyticsReporting?: boolean;
                        crossRegionReferences?: boolean;
                        permissionsBoundary?: PermissionsBoundary;
                        suppressTemplateIndentation?: boolean;
                    }

                    Hierarchy

                    • StackProps
                      • EmbeddedLinuxCodePipelineBaseImageProps

                    Properties

                    pipelineSourceBucket -pipelineSourcePrefix? -pipelineArtifactBucket -ecrRepository -encryptionKey -description? -env? -stackName? -tags? -notificationArns? -synthesizer? -terminationProtection? -analyticsReporting? -crossRegionReferences? -permissionsBoundary? -suppressTemplateIndentation? -

                    Properties

                    ReadonlypipelineSourceBucket

                    pipelineSourceBucket: IBucket

                    The pipeline source bucket

                    -

                    OptionalpipelineSourcePrefix

                    pipelineSourcePrefix?: string

                    The pipeline source prefix

                    -

                    ReadonlypipelineArtifactBucket

                    pipelineArtifactBucket: Bucket

                    Artifact bucket to use

                    -

                    ReadonlyecrRepository

                    ecrRepository: IRepository

                    The ECR Repository to push to.

                    -

                    ReadonlyencryptionKey

                    encryptionKey: Key

                    The encryption key use across

                    -

                    Optional Readonlydescription

                    description?: string

                    A description of the stack.

                    -

                    Default

                    - No description.
+EmbeddedLinuxCodePipelineBaseImageProps | aws4embeddedlinux-cdk-lib
                    aws4embeddedlinux-cdk-lib
                      Preparing search index...
                      Interface EmbeddedLinuxCodePipelineBaseImageProps
                      Select options for the BuildImageCodePipelineStack.
                      
+
                      interface EmbeddedLinuxCodePipelineBaseImageProps {
                          description?: string;
                          env?: Environment;
                          stackName?: string;
                          tags?: { [key: string]: string };
                          notificationArns?: string[];
                          synthesizer?: IStackSynthesizer;
                          terminationProtection?: boolean;
                          analyticsReporting?: boolean;
                          crossRegionReferences?: boolean;
                          permissionsBoundary?: PermissionsBoundary;
                          suppressTemplateIndentation?: boolean;
                          pipelineSourceBucket: IBucket;
                          pipelineSourcePrefix?: string;
                          pipelineArtifactBucket: Bucket;
                          ecrRepository: IRepository;
                          encryptionKey: Key;
                      }
                      Hierarchy
                      • StackProps
                        • EmbeddedLinuxCodePipelineBaseImageProps
                      Index
                      Properties
                      description?
+env?
+stackName?
+tags?
+notificationArns?
+synthesizer?
+terminationProtection?
+analyticsReporting?
+crossRegionReferences?
+permissionsBoundary?
+suppressTemplateIndentation?
+pipelineSourceBucket
+pipelineSourcePrefix?
+pipelineArtifactBucket
+ecrRepository
+encryptionKey
+
                      Properties
                      description?: string
                      A description of the stack.
                      
+
                      - No description.
 
                      
 
-
                      Optional Readonlyenv
                      env?: Environment
                      The AWS environment (account/region) where this stack will be deployed.
                      
+
                      env?: Environment

                      The AWS environment (account/region) where this stack will be deployed.

                      Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables @@ -41,26 +36,26 @@ use environmental context lookups such as ec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements.

                      -

                      Example

                      // Use a concrete account and region to deploy this stack to:
                      // `.account` and `.region` will simply return these values.
                      new Stack(app, 'Stack1', {
                        env: {
                          account: '123456789012',
                          region: 'us-east-1'
                        },
                      });

                      // Use the CLI's current credentials to determine the target environment:
                      // `.account` and `.region` will reflect the account+region the CLI
                      // is configured to use (based on the user CLI credentials)
                      new Stack(app, 'Stack2', {
                        env: {
                          account: process.env.CDK_DEFAULT_ACCOUNT,
                          region: process.env.CDK_DEFAULT_REGION
                        },
                      });

                      // Define multiple stacks stage associated with an environment
                      const myStage = new Stage(app, 'MyStage', {
                        env: {
                          account: '123456789012',
                          region: 'us-east-1'
                        }
                      });

                      // both of these stacks will use the stage's account/region:
                      // `.account` and `.region` will resolve to the concrete values as above
                      new MyStack(myStage, 'Stack1');
                      new YourStack(myStage, 'Stack2');

                      // Define an environment-agnostic stack:
                      // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
                      // which will only resolve to actual values by CloudFormation during deployment.
                      new MyStack(app, 'Stack1');
+
                      // Use a concrete account and region to deploy this stack to:
                      // `.account` and `.region` will simply return these values.
                      new Stack(app, 'Stack1', {
                        env: {
                          account: '123456789012',
                          region: 'us-east-1'
                        },
                      });

                      // Use the CLI's current credentials to determine the target environment:
                      // `.account` and `.region` will reflect the account+region the CLI
                      // is configured to use (based on the user CLI credentials)
                      new Stack(app, 'Stack2', {
                        env: {
                          account: process.env.CDK_DEFAULT_ACCOUNT,
                          region: process.env.CDK_DEFAULT_REGION
                        },
                      });

                      // Define multiple stacks stage associated with an environment
                      const myStage = new Stage(app, 'MyStage', {
                        env: {
                          account: '123456789012',
                          region: 'us-east-1'
                        }
                      });

                      // both of these stacks will use the stage's account/region:
                      // `.account` and `.region` will resolve to the concrete values as above
                      new MyStack(myStage, 'Stack1');
                      new YourStack(myStage, 'Stack2');

                      // Define an environment-agnostic stack:
                      // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
                      // which will only resolve to actual values by CloudFormation during deployment.
                      new MyStack(app, 'Stack1');
                      -

                      Default

                        +
                      • The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
                      -

                      Optional ReadonlystackName

                      stackName?: string

                      Name to deploy the stack with

                      -

                      Default

                      - Derived from construct path.
+
                      stackName?: string

                      Name to deploy the stack with

                      +
                      - Derived from construct path.
                      -

                      Optional Readonlytags

                      tags?: { [key: string]: string }

                      Stack tags that will be applied to all the taggable resources and the stack itself.

                      -

                      Default

                      {}
+
                      tags?: { [key: string]: string }

                      Stack tags that will be applied to all the taggable resources and the stack itself.

                      +
                      {}
                      -

                      Optional ReadonlynotificationArns

                      notificationArns?: string[]

                      SNS Topic ARNs that will receive stack events.

                      -

                      Default

                      - no notfication arns.
+
                      notificationArns?: string[]

                      SNS Topic ARNs that will receive stack events.

                      +
                      - no notfication arns.
                      -

                      Optional Readonlysynthesizer

                      synthesizer?: IStackSynthesizer

                      Synthesis method to use while deploying this stack

                      +
                      synthesizer?: IStackSynthesizer

                      Synthesis method to use while deploying this stack

                      The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

                      @@ -69,34 +64,39 @@ @aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.

                      -

                      Default

                        +
                      • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
                      -

                      Optional ReadonlyterminationProtection

                      terminationProtection?: boolean

                      Whether to enable termination protection for this stack.

                      -

                      Default

                      false
+
                      terminationProtection?: boolean

                      Whether to enable termination protection for this stack.

                      +
                      false
                      -

                      Optional ReadonlyanalyticsReporting

                      analyticsReporting?: boolean

                      Include runtime versioning information in this Stack

                      -

                      Default

                      analyticsReporting setting of containing App, or value of +

                      analyticsReporting?: boolean

                      Include runtime versioning information in this Stack

                      +

                      analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key

                      -

                      Optional ReadonlycrossRegionReferences

                      crossRegionReferences?: boolean

                      Enable this flag to allow native cross region stack references.

                      +
                      crossRegionReferences?: boolean

                      Enable this flag to allow native cross region stack references.

                      Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

                      This feature is currently experimental

                      -

                      Default

                      false
+
                      false
                      -

                      Optional ReadonlypermissionsBoundary

                      permissionsBoundary?: PermissionsBoundary

                      Options for applying a permissions boundary to all IAM Roles +

                      permissionsBoundary?: PermissionsBoundary

                      Options for applying a permissions boundary to all IAM Roles and Users created within this Stage

                      -

                      Default

                      - no permissions boundary is applied
+
                      - no permissions boundary is applied
                      -

                      Optional ReadonlysuppressTemplateIndentation

                      suppressTemplateIndentation?: boolean

                      Enable this flag to suppress indentation in generated +

                      suppressTemplateIndentation?: boolean

                      Enable this flag to suppress indentation in generated CloudFormation templates.

                      If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used.

                      -

                      Default

                        +
                      • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                      -

                      Settings

                      Member Visibility

                      On This Page

                      Properties
                      +
                      pipelineSourceBucket: IBucket

                      The pipeline source bucket

                      +
                      pipelineSourcePrefix?: string

                      The pipeline source prefix

                      +
                      pipelineArtifactBucket: Bucket

                      Artifact bucket to use

                      +
                      ecrRepository: IRepository

                      The ECR Repository to push to.

                      +
                      encryptionKey: Key

                      The encryption key use across

                      +

                      Settings

                      Member Visibility

                      On This Page

                      Properties
                      diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index e93c508..7f54240 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,48 +1,34 @@ -EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib

                      Interface EmbeddedLinuxCodePipelineProps

                      Properties to allow customizing the build.

                      -
                      interface EmbeddedLinuxCodePipelineProps {
                          pipelineSourceBucket: IBucket;
                          pipelineSourcePrefix?: string;
                          pipelineArtifactBucket: Bucket;
                          pipelineArtifactPrefix?: string;
                          pipelineOutputBucket: Bucket;
                          pipelineOutputPrefix?: string;
                          ecrRepository: IRepository;
                          ecrRepositoryImageTag: string;
                          projectType: ProjectType;
                          vpc: IVpc;
                          buildPolicyAdditions?: PolicyStatement[];
                          environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                          encryptionKey: Key;
                          sourceCustomPath?: string;
                          description?: string;
                          env?: Environment;
                          stackName?: string;
                          tags?: { [key: string]: string };
                          notificationArns?: string[];
                          synthesizer?: IStackSynthesizer;
                          terminationProtection?: boolean;
                          analyticsReporting?: boolean;
                          crossRegionReferences?: boolean;
                          permissionsBoundary?: PermissionsBoundary;
                          suppressTemplateIndentation?: boolean;
                      }

                      Hierarchy

                      • StackProps
                        • EmbeddedLinuxCodePipelineProps

                      Properties

                      pipelineSourceBucket -pipelineSourcePrefix? -pipelineArtifactBucket -pipelineArtifactPrefix? -pipelineOutputBucket -pipelineOutputPrefix? -ecrRepository -ecrRepositoryImageTag -projectType -vpc -buildPolicyAdditions? -environmentVariables? -encryptionKey -sourceCustomPath? -description? -env? -stackName? -tags? -notificationArns? -synthesizer? -terminationProtection? -analyticsReporting? -crossRegionReferences? -permissionsBoundary? -suppressTemplateIndentation? -

                      Properties

                      ReadonlypipelineSourceBucket

                      pipelineSourceBucket: IBucket

                      The pipeline source bucket

                      -

                      OptionalpipelineSourcePrefix

                      pipelineSourcePrefix?: string

                      The pipeline source prefix

                      -

                      ReadonlypipelineArtifactBucket

                      pipelineArtifactBucket: Bucket

                      The pipeline artifact bucket to use

                      -

                      OptionalpipelineArtifactPrefix

                      pipelineArtifactPrefix?: string

                      The pipeline artifact bucket prefix to use

                      -

                      ReadonlypipelineOutputBucket

                      pipelineOutputBucket: Bucket

                      The pipeline output bucket to use

                      -

                      OptionalpipelineOutputPrefix

                      pipelineOutputPrefix?: string

                      The pipeline output bucket prefix to use

                      -

                      ReadonlyecrRepository

                      ecrRepository: IRepository

                      ECR Repository where the Build Host Image resides.

                      -

                      ReadonlyecrRepositoryImageTag

                      ecrRepositoryImageTag: string

                      Tag for the Build Host Image

                      -

                      ReadonlyprojectType

                      projectType: ProjectType

                      The type of project being built.

                      -

                      Readonlyvpc

                      vpc: IVpc

                      VPC where the networking setup resides.

                      -

                      Optional ReadonlybuildPolicyAdditions

                      buildPolicyAdditions?: PolicyStatement[]

                      Additional policy statements to add to the build project.

                      -

                      Optional ReadonlyenvironmentVariables

                      environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                      Additional build environment variables to the build project.

                      -

                      ReadonlyencryptionKey

                      encryptionKey: Key

                      The encryption key use across

                      -

                      Optional ReadonlysourceCustomPath

                      sourceCustomPath?: string

                      Custom asset to be provided when using ProjectType.Custom

                      -

                      Optional Readonlydescription

                      description?: string

                      A description of the stack.

                      -

                      Default

                      - No description.
+EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                      aws4embeddedlinux-cdk-lib
                        Preparing search index...
                        Interface EmbeddedLinuxCodePipelineProps
                        Properties to allow customizing the build.
                        
+
                        interface EmbeddedLinuxCodePipelineProps {
                            description?: string;
                            env?: Environment;
                            stackName?: string;
                            tags?: { [key: string]: string };
                            notificationArns?: string[];
                            synthesizer?: IStackSynthesizer;
                            terminationProtection?: boolean;
                            analyticsReporting?: boolean;
                            crossRegionReferences?: boolean;
                            permissionsBoundary?: PermissionsBoundary;
                            suppressTemplateIndentation?: boolean;
                            pipelineSourceBucket: IBucket;
                            pipelineSourcePrefix?: string;
                            pipelineArtifactBucket: Bucket;
                            pipelineArtifactPrefix?: string;
                            pipelineOutputBucket: Bucket;
                            pipelineOutputPrefix?: string;
                            ecrRepository: IRepository;
                            ecrRepositoryImageTag: string;
                            projectType: ProjectType;
                            vpc: IVpc;
                            buildPolicyAdditions?: PolicyStatement[];
                            environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                            encryptionKey: Key;
                            sourceCustomPath?: string;
                        }
                        Hierarchy
                        • StackProps
                          • EmbeddedLinuxCodePipelineProps
                        Index
                        Properties
                        description?
+env?
+stackName?
+tags?
+notificationArns?
+synthesizer?
+terminationProtection?
+analyticsReporting?
+crossRegionReferences?
+permissionsBoundary?
+suppressTemplateIndentation?
+pipelineSourceBucket
+pipelineSourcePrefix?
+pipelineArtifactBucket
+pipelineArtifactPrefix?
+pipelineOutputBucket
+pipelineOutputPrefix?
+ecrRepository
+ecrRepositoryImageTag
+projectType
+vpc
+buildPolicyAdditions?
+environmentVariables?
+encryptionKey
+sourceCustomPath?
+
                        Properties
                        description?: string
                        A description of the stack.
                        
+
                        - No description.
 
                        
 
-
                        Optional Readonlyenv
                        env?: Environment
                        The AWS environment (account/region) where this stack will be deployed.
                        
+
                        env?: Environment

                        The AWS environment (account/region) where this stack will be deployed.

                        Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables @@ -59,26 +45,26 @@ use environmental context lookups such as ec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements.

                        -

                        Example

                        // Use a concrete account and region to deploy this stack to:
                        // `.account` and `.region` will simply return these values.
                        new Stack(app, 'Stack1', {
                          env: {
                            account: '123456789012',
                            region: 'us-east-1'
                          },
                        });

                        // Use the CLI's current credentials to determine the target environment:
                        // `.account` and `.region` will reflect the account+region the CLI
                        // is configured to use (based on the user CLI credentials)
                        new Stack(app, 'Stack2', {
                          env: {
                            account: process.env.CDK_DEFAULT_ACCOUNT,
                            region: process.env.CDK_DEFAULT_REGION
                          },
                        });

                        // Define multiple stacks stage associated with an environment
                        const myStage = new Stage(app, 'MyStage', {
                          env: {
                            account: '123456789012',
                            region: 'us-east-1'
                          }
                        });

                        // both of these stacks will use the stage's account/region:
                        // `.account` and `.region` will resolve to the concrete values as above
                        new MyStack(myStage, 'Stack1');
                        new YourStack(myStage, 'Stack2');

                        // Define an environment-agnostic stack:
                        // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
                        // which will only resolve to actual values by CloudFormation during deployment.
                        new MyStack(app, 'Stack1');
+
                        // Use a concrete account and region to deploy this stack to:
                        // `.account` and `.region` will simply return these values.
                        new Stack(app, 'Stack1', {
                          env: {
                            account: '123456789012',
                            region: 'us-east-1'
                          },
                        });

                        // Use the CLI's current credentials to determine the target environment:
                        // `.account` and `.region` will reflect the account+region the CLI
                        // is configured to use (based on the user CLI credentials)
                        new Stack(app, 'Stack2', {
                          env: {
                            account: process.env.CDK_DEFAULT_ACCOUNT,
                            region: process.env.CDK_DEFAULT_REGION
                          },
                        });

                        // Define multiple stacks stage associated with an environment
                        const myStage = new Stage(app, 'MyStage', {
                          env: {
                            account: '123456789012',
                            region: 'us-east-1'
                          }
                        });

                        // both of these stacks will use the stage's account/region:
                        // `.account` and `.region` will resolve to the concrete values as above
                        new MyStack(myStage, 'Stack1');
                        new YourStack(myStage, 'Stack2');

                        // Define an environment-agnostic stack:
                        // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
                        // which will only resolve to actual values by CloudFormation during deployment.
                        new MyStack(app, 'Stack1');
                        -

                        Default

                          +
                        • The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
                        -

                        Optional ReadonlystackName

                        stackName?: string

                        Name to deploy the stack with

                        -

                        Default

                        - Derived from construct path.
+
                        stackName?: string

                        Name to deploy the stack with

                        +
                        - Derived from construct path.
                        -

                        Optional Readonlytags

                        tags?: { [key: string]: string }

                        Stack tags that will be applied to all the taggable resources and the stack itself.

                        -

                        Default

                        {}
+
                        tags?: { [key: string]: string }

                        Stack tags that will be applied to all the taggable resources and the stack itself.

                        +
                        {}
                        -

                        Optional ReadonlynotificationArns

                        notificationArns?: string[]

                        SNS Topic ARNs that will receive stack events.

                        -

                        Default

                        - no notfication arns.
+
                        notificationArns?: string[]

                        SNS Topic ARNs that will receive stack events.

                        +
                        - no notfication arns.
                        -

                        Optional Readonlysynthesizer

                        synthesizer?: IStackSynthesizer

                        Synthesis method to use while deploying this stack

                        +
                        synthesizer?: IStackSynthesizer

                        Synthesis method to use while deploying this stack

                        The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

                        @@ -87,34 +73,48 @@ @aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.

                        -

                        Default

                          +
                        • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
                        -

                        Optional ReadonlyterminationProtection

                        terminationProtection?: boolean

                        Whether to enable termination protection for this stack.

                        -

                        Default

                        false
+
                        terminationProtection?: boolean

                        Whether to enable termination protection for this stack.

                        +
                        false
                        -

                        Optional ReadonlyanalyticsReporting

                        analyticsReporting?: boolean

                        Include runtime versioning information in this Stack

                        -

                        Default

                        analyticsReporting setting of containing App, or value of +

                        analyticsReporting?: boolean

                        Include runtime versioning information in this Stack

                        +

                        analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key

                        -

                        Optional ReadonlycrossRegionReferences

                        crossRegionReferences?: boolean

                        Enable this flag to allow native cross region stack references.

                        +
                        crossRegionReferences?: boolean

                        Enable this flag to allow native cross region stack references.

                        Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

                        This feature is currently experimental

                        -

                        Default

                        false
+
                        false
                        -

                        Optional ReadonlypermissionsBoundary

                        permissionsBoundary?: PermissionsBoundary

                        Options for applying a permissions boundary to all IAM Roles +

                        permissionsBoundary?: PermissionsBoundary

                        Options for applying a permissions boundary to all IAM Roles and Users created within this Stage

                        -

                        Default

                        - no permissions boundary is applied
+
                        - no permissions boundary is applied
                        -

                        Optional ReadonlysuppressTemplateIndentation

                        suppressTemplateIndentation?: boolean

                        Enable this flag to suppress indentation in generated +

                        suppressTemplateIndentation?: boolean

                        Enable this flag to suppress indentation in generated CloudFormation templates.

                        If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used.

                        -

                        Default

                          +
                        • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                        -

                        Settings

                        Member Visibility

                        On This Page

                        Properties
                        +
                        pipelineSourceBucket: IBucket

                        The pipeline source bucket

                        +
                        pipelineSourcePrefix?: string

                        The pipeline source prefix

                        +
                        pipelineArtifactBucket: Bucket

                        The pipeline artifact bucket to use

                        +
                        pipelineArtifactPrefix?: string

                        The pipeline artifact bucket prefix to use

                        +
                        pipelineOutputBucket: Bucket

                        The pipeline output bucket to use

                        +
                        pipelineOutputPrefix?: string

                        The pipeline output bucket prefix to use

                        +
                        ecrRepository: IRepository

                        ECR Repository where the Build Host Image resides.

                        +
                        ecrRepositoryImageTag: string

                        Tag for the Build Host Image

                        +
                        projectType: ProjectType

                        The type of project being built.

                        +
                        vpc: IVpc

                        VPC where the networking setup resides.

                        +
                        buildPolicyAdditions?: PolicyStatement[]

                        Additional policy statements to add to the build project.

                        +
                        environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                        Additional build environment variables to the build project.

                        +
                        encryptionKey: Key

                        The encryption key use across

                        +
                        sourceCustomPath?: string

                        Custom asset to be provided when using ProjectType.Custom

                        +

                        Settings

                        Member Visibility

                        On This Page

                        Properties
                        diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index b39d2c2..5371f9c 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,32 +1,26 @@ -PipelineResourcesProps | aws4embeddedlinux-cdk-lib

                        Interface PipelineResourcesProps

                        Select options for the PipelineResourcesStack.

                        -
                        interface PipelineResourcesProps {
                            resource_prefix: string;
                            ecrRepositoryName?: string;
                            pipelineArtifactBucketName?: string;
                            pipelineSourceBucketName?: string;
                            pipelineOutputBucketName?: string;
                            loggingBucketName?: string;
                            description?: string;
                            env?: Environment;
                            stackName?: string;
                            tags?: { [key: string]: string };
                            notificationArns?: string[];
                            synthesizer?: IStackSynthesizer;
                            terminationProtection?: boolean;
                            analyticsReporting?: boolean;
                            crossRegionReferences?: boolean;
                            permissionsBoundary?: PermissionsBoundary;
                            suppressTemplateIndentation?: boolean;
                        }

                        Hierarchy

                        • StackProps
                          • PipelineResourcesProps

                        Properties

                        resource_prefix -ecrRepositoryName? -pipelineArtifactBucketName? -pipelineSourceBucketName? -pipelineOutputBucketName? -loggingBucketName? -description? -env? -stackName? -tags? -notificationArns? -synthesizer? -terminationProtection? -analyticsReporting? -crossRegionReferences? -permissionsBoundary? -suppressTemplateIndentation? -

                        Properties

                        Readonlyresource_prefix

                        resource_prefix: string

                        The resource prefix

                        -

                        Optional ReadonlyecrRepositoryName

                        ecrRepositoryName?: string

                        The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                        -

                        Optional ReadonlypipelineArtifactBucketName

                        pipelineArtifactBucketName?: string

                        The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                        -

                        Optional ReadonlypipelineSourceBucketName

                        pipelineSourceBucketName?: string

                        The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                        -

                        Optional ReadonlypipelineOutputBucketName

                        pipelineOutputBucketName?: string

                        The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                        -

                        Optional ReadonlyloggingBucketName

                        loggingBucketName?: string

                        Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                        -

                        Optional Readonlydescription

                        description?: string

                        A description of the stack.

                        -

                        Default

                        - No description.
+PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                        aws4embeddedlinux-cdk-lib
                          Preparing search index...
                          Interface PipelineResourcesProps
                          Select options for the PipelineResourcesStack.
                          
+
                          interface PipelineResourcesProps {
                              description?: string;
                              env?: Environment;
                              stackName?: string;
                              tags?: { [key: string]: string };
                              notificationArns?: string[];
                              synthesizer?: IStackSynthesizer;
                              terminationProtection?: boolean;
                              analyticsReporting?: boolean;
                              crossRegionReferences?: boolean;
                              permissionsBoundary?: PermissionsBoundary;
                              suppressTemplateIndentation?: boolean;
                              resource_prefix: string;
                              ecrRepositoryName?: string;
                              pipelineArtifactBucketName?: string;
                              pipelineSourceBucketName?: string;
                              pipelineOutputBucketName?: string;
                              loggingBucketName?: string;
                          }
                          Hierarchy
                          • StackProps
                            • PipelineResourcesProps
                          Index
                          Properties
                          description?
+env?
+stackName?
+tags?
+notificationArns?
+synthesizer?
+terminationProtection?
+analyticsReporting?
+crossRegionReferences?
+permissionsBoundary?
+suppressTemplateIndentation?
+resource_prefix
+ecrRepositoryName?
+pipelineArtifactBucketName?
+pipelineSourceBucketName?
+pipelineOutputBucketName?
+loggingBucketName?
+
                          Properties
                          description?: string
                          A description of the stack.
                          
+
                          - No description.
 
                          
 
-
                          Optional Readonlyenv
                          env?: Environment
                          The AWS environment (account/region) where this stack will be deployed.
                          
+
                          env?: Environment

                          The AWS environment (account/region) where this stack will be deployed.

                          Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables @@ -43,26 +37,26 @@ use environmental context lookups such as ec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements.

                          -

                          Example

                          // Use a concrete account and region to deploy this stack to:
                          // `.account` and `.region` will simply return these values.
                          new Stack(app, 'Stack1', {
                            env: {
                              account: '123456789012',
                              region: 'us-east-1'
                            },
                          });

                          // Use the CLI's current credentials to determine the target environment:
                          // `.account` and `.region` will reflect the account+region the CLI
                          // is configured to use (based on the user CLI credentials)
                          new Stack(app, 'Stack2', {
                            env: {
                              account: process.env.CDK_DEFAULT_ACCOUNT,
                              region: process.env.CDK_DEFAULT_REGION
                            },
                          });

                          // Define multiple stacks stage associated with an environment
                          const myStage = new Stage(app, 'MyStage', {
                            env: {
                              account: '123456789012',
                              region: 'us-east-1'
                            }
                          });

                          // both of these stacks will use the stage's account/region:
                          // `.account` and `.region` will resolve to the concrete values as above
                          new MyStack(myStage, 'Stack1');
                          new YourStack(myStage, 'Stack2');

                          // Define an environment-agnostic stack:
                          // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
                          // which will only resolve to actual values by CloudFormation during deployment.
                          new MyStack(app, 'Stack1');
+
                          // Use a concrete account and region to deploy this stack to:
                          // `.account` and `.region` will simply return these values.
                          new Stack(app, 'Stack1', {
                            env: {
                              account: '123456789012',
                              region: 'us-east-1'
                            },
                          });

                          // Use the CLI's current credentials to determine the target environment:
                          // `.account` and `.region` will reflect the account+region the CLI
                          // is configured to use (based on the user CLI credentials)
                          new Stack(app, 'Stack2', {
                            env: {
                              account: process.env.CDK_DEFAULT_ACCOUNT,
                              region: process.env.CDK_DEFAULT_REGION
                            },
                          });

                          // Define multiple stacks stage associated with an environment
                          const myStage = new Stage(app, 'MyStage', {
                            env: {
                              account: '123456789012',
                              region: 'us-east-1'
                            }
                          });

                          // both of these stacks will use the stage's account/region:
                          // `.account` and `.region` will resolve to the concrete values as above
                          new MyStack(myStage, 'Stack1');
                          new YourStack(myStage, 'Stack2');

                          // Define an environment-agnostic stack:
                          // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
                          // which will only resolve to actual values by CloudFormation during deployment.
                          new MyStack(app, 'Stack1');
                          -

                          Default

                            +
                          • The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
                          -

                          Optional ReadonlystackName

                          stackName?: string

                          Name to deploy the stack with

                          -

                          Default

                          - Derived from construct path.
+
                          stackName?: string

                          Name to deploy the stack with

                          +
                          - Derived from construct path.
                          -

                          Optional Readonlytags

                          tags?: { [key: string]: string }

                          Stack tags that will be applied to all the taggable resources and the stack itself.

                          -

                          Default

                          {}
+
                          tags?: { [key: string]: string }

                          Stack tags that will be applied to all the taggable resources and the stack itself.

                          +
                          {}
                          -

                          Optional ReadonlynotificationArns

                          notificationArns?: string[]

                          SNS Topic ARNs that will receive stack events.

                          -

                          Default

                          - no notfication arns.
+
                          notificationArns?: string[]

                          SNS Topic ARNs that will receive stack events.

                          +
                          - no notfication arns.
                          -

                          Optional Readonlysynthesizer

                          synthesizer?: IStackSynthesizer

                          Synthesis method to use while deploying this stack

                          +
                          synthesizer?: IStackSynthesizer

                          Synthesis method to use while deploying this stack

                          The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

                          @@ -71,34 +65,40 @@ @aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.

                          -

                          Default

                            +
                          • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
                          -

                          Optional ReadonlyterminationProtection

                          terminationProtection?: boolean

                          Whether to enable termination protection for this stack.

                          -

                          Default

                          false
+
                          terminationProtection?: boolean

                          Whether to enable termination protection for this stack.

                          +
                          false
                          -

                          Optional ReadonlyanalyticsReporting

                          analyticsReporting?: boolean

                          Include runtime versioning information in this Stack

                          -

                          Default

                          analyticsReporting setting of containing App, or value of +

                          analyticsReporting?: boolean

                          Include runtime versioning information in this Stack

                          +

                          analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key

                          -

                          Optional ReadonlycrossRegionReferences

                          crossRegionReferences?: boolean

                          Enable this flag to allow native cross region stack references.

                          +
                          crossRegionReferences?: boolean

                          Enable this flag to allow native cross region stack references.

                          Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

                          This feature is currently experimental

                          -

                          Default

                          false
+
                          false
                          -

                          Optional ReadonlypermissionsBoundary

                          permissionsBoundary?: PermissionsBoundary

                          Options for applying a permissions boundary to all IAM Roles +

                          permissionsBoundary?: PermissionsBoundary

                          Options for applying a permissions boundary to all IAM Roles and Users created within this Stage

                          -

                          Default

                          - no permissions boundary is applied
+
                          - no permissions boundary is applied
                          -

                          Optional ReadonlysuppressTemplateIndentation

                          suppressTemplateIndentation?: boolean

                          Enable this flag to suppress indentation in generated +

                          suppressTemplateIndentation?: boolean

                          Enable this flag to suppress indentation in generated CloudFormation templates.

                          If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used.

                          -

                          Default

                            +
                          • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                          -

                          Settings

                          Member Visibility

                          On This Page

                          Properties
                          +
                          resource_prefix: string

                          The resource prefix

                          +
                          ecrRepositoryName?: string

                          The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                          +
                          pipelineArtifactBucketName?: string

                          The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                          +
                          pipelineSourceBucketName?: string

                          The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                          +
                          pipelineOutputBucketName?: string

                          The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                          +
                          loggingBucketName?: string

                          Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                          +

                          Settings

                          Member Visibility

                          On This Page

                          Properties
                          diff --git a/modules.html b/modules.html index 1d25f5e..388aa61 100644 --- a/modules.html +++ b/modules.html @@ -1 +1 @@ -aws4embeddedlinux-cdk-lib

                          aws4embeddedlinux-cdk-lib

                          Enumerations

                          ProjectType

                          Classes

                          EmbeddedLinuxCodeBuildProjectStack
                          EmbeddedLinuxCodePipelineBaseImageStack
                          EmbeddedLinuxCodePipelineStack
                          PipelineResourcesStack

                          Interfaces

                          EmbeddedLinuxCodeBuildProjectProps
                          EmbeddedLinuxCodePipelineBaseImageProps
                          EmbeddedLinuxCodePipelineProps
                          PipelineResourcesProps

                          Settings

                          Member Visibility

                          On This Page

                          Enumerations
                          Classes
                          Interfaces
                          +aws4embeddedlinux-cdk-lib
                          aws4embeddedlinux-cdk-lib
                            Preparing search index...

                              aws4embeddedlinux-cdk-lib

                              Enumerations

                              ProjectType

                              Classes

                              EmbeddedLinuxCodeBuildProjectStack
                              EmbeddedLinuxCodePipelineBaseImageStack
                              EmbeddedLinuxCodePipelineStack
                              PipelineResourcesStack

                              Interfaces

                              EmbeddedLinuxCodeBuildProjectProps
                              EmbeddedLinuxCodePipelineBaseImageProps
                              EmbeddedLinuxCodePipelineProps
                              PipelineResourcesProps

                              Settings

                              Member Visibility

                              On This Page

                              Enumerations
                              Classes
                              Interfaces
                              From 02b3aab5334fa6224d077a46ad5b000ae5b796fb Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 28 Apr 2025 19:08:46 +0000 Subject: [PATCH 30/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@fdd85fc929e83641aa51d31ae3?= =?UTF-8?q?1d686ee6459a9e=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index b8e8a69..9f8cf16 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                              aws4embeddedlinux-cdk-lib
                                Preparing search index...

                                Class EmbeddedLinuxCodeBuildProjectStack

                                The stack for creating a build pipeline.

                                See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                -

                                Hierarchy

                                • Stack
                                  • EmbeddedLinuxCodeBuildProjectStack
                                Index

                                Constructors

                                constructor +

                                Hierarchy

                                • Stack
                                  • EmbeddedLinuxCodeBuildProjectStack
                                Index

                                Constructors

                                constructor

                                Properties

                                tags templateOptions region @@ -50,7 +50,7 @@ _toCloudFormation isConstruct toString -

                                Constructors

                                Properties

                                tags: TagManager

                                Tags to be applied to the stack.

                                +

                                Constructors

                                Properties

                                tags: TagManager

                                Tags to be applied to the stack.

                                templateOptions: ITemplateOptions

                                Options for CloudFormation template (like version, transform, description).

                                region: string

                                The AWS region into which this stack will be deployed (e.g. us-west-2).

                                This value is resolved according to the following rules:

                                diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index a8a6dd9..8d29a16 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                aws4embeddedlinux-cdk-lib
                                  Preparing search index...

                                  Class EmbeddedLinuxCodePipelineBaseImageStack

                                  The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                  For configuration options see BuildBaseImageCodePipelineProps.

                                  -

                                  Hierarchy

                                  • Stack
                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                  Index

                                  Constructors

                                  constructor +

                                  Hierarchy

                                  • Stack
                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                  Index

                                  Constructors

                                  constructor

                                  Properties

                                  tags templateOptions region @@ -53,7 +53,7 @@ _toCloudFormation isConstruct toString -

                                  Constructors

                                  Properties

                                  tags: TagManager

                                  Tags to be applied to the stack.

                                  +

                                  Constructors

                                  Properties

                                  tags: TagManager

                                  Tags to be applied to the stack.

                                  templateOptions: ITemplateOptions

                                  Options for CloudFormation template (like version, transform, description).

                                  region: string

                                  The AWS region into which this stack will be deployed (e.g. us-west-2).

                                  This value is resolved according to the following rules:

                                  @@ -110,8 +110,8 @@

                                  Readonly Internal_crossRegionReferences

                                  _crossRegionReferences: boolean

                                  Whether cross region references are enabled for this stack

                                  Optional Readonly Internal_notificationArns

                                  _notificationArns?: string[]

                                  SNS Notification ARNs to receive stack events.

                                  ecrRepository: IRepository

                                  The ECR Repository where the image is located.

                                  -
                                  ecrRepositoryImageTag: string

                                  The ECR Image Tag to find the base imaged.

                                  -
                                  node: Node

                                  The tree node.

                                  +
                                  ecrRepositoryImageTag: string

                                  The ECR Image Tag to find the base imaged.

                                  +
                                  node: Node

                                  The tree node.

                                  Accessors

                                  • get terminationProtection(): boolean

                                    Whether termination protection is enabled for this stack.

                                    Returns boolean

                                  • set terminationProtection(value: boolean): void

                                    Parameters

                                    • value: boolean

                                    Returns void

                                  • get dependencies(): Stack[]

                                    Return the stacks this stack depends on

                                    Returns Stack[]

                                  ecrRepository: IRepository

                                  ECR Repository where the Build Host Image resides.

                                  -
                                  ecrRepositoryImageTag: string

                                  Tag for the Build Host Image

                                  -
                                  vpc: IVpc

                                  VPC where the networking setup resides.

                                  -
                                  buildPolicyAdditions?: PolicyStatement[]

                                  Additional policy statements to add to the build project.

                                  -
                                  encryptionKey: Key

                                  The encryption key use across

                                  -

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Properties
                                  +
                                  ecrRepositoryImageTag: string

                                  Tag for the Build Host Image

                                  +
                                  vpc: IVpc

                                  VPC where the networking setup resides.

                                  +
                                  buildPolicyAdditions?: PolicyStatement[]

                                  Additional policy statements to add to the build project.

                                  +
                                  encryptionKey: Key

                                  The encryption key use across

                                  +

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Properties
                                  diff --git a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html index 8bf2275..d211ccc 100644 --- a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineBaseImageProps | aws4embeddedlinux-cdk-lib
                                  aws4embeddedlinux-cdk-lib
                                    Preparing search index...

                                    Interface EmbeddedLinuxCodePipelineBaseImageProps

                                    Select options for the BuildImageCodePipelineStack.

                                    -
                                    interface EmbeddedLinuxCodePipelineBaseImageProps {
                                        description?: string;
                                        env?: Environment;
                                        stackName?: string;
                                        tags?: { [key: string]: string };
                                        notificationArns?: string[];
                                        synthesizer?: IStackSynthesizer;
                                        terminationProtection?: boolean;
                                        analyticsReporting?: boolean;
                                        crossRegionReferences?: boolean;
                                        permissionsBoundary?: PermissionsBoundary;
                                        suppressTemplateIndentation?: boolean;
                                        pipelineSourceBucket: IBucket;
                                        pipelineSourcePrefix?: string;
                                        pipelineArtifactBucket: Bucket;
                                        ecrRepository: IRepository;
                                        encryptionKey: Key;
                                    }

                                    Hierarchy

                                    • StackProps
                                      • EmbeddedLinuxCodePipelineBaseImageProps
                                    Index

                                    Properties

                                    description? +
                                    interface EmbeddedLinuxCodePipelineBaseImageProps {
                                        description?: string;
                                        env?: Environment;
                                        stackName?: string;
                                        tags?: { [key: string]: string };
                                        notificationArns?: string[];
                                        synthesizer?: IStackSynthesizer;
                                        terminationProtection?: boolean;
                                        analyticsReporting?: boolean;
                                        crossRegionReferences?: boolean;
                                        permissionsBoundary?: PermissionsBoundary;
                                        suppressTemplateIndentation?: boolean;
                                        pipelineSourceBucket: IBucket;
                                        pipelineSourcePrefix?: string;
                                        pipelineArtifactBucket: Bucket;
                                        ecrRepository: IRepository;
                                        encryptionKey: Key;
                                    }

                                    Hierarchy

                                    • StackProps
                                      • EmbeddedLinuxCodePipelineBaseImageProps
                                    Index

                                    Properties

                                    description? env? stackName? tags? @@ -95,8 +95,8 @@
                                  • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                    • pipelineSourceBucket: IBucket

                                    The pipeline source bucket

                                    -
                                    pipelineSourcePrefix?: string

                                    The pipeline source prefix

                                    -
                                    pipelineArtifactBucket: Bucket

                                    Artifact bucket to use

                                    -
                                    ecrRepository: IRepository

                                    The ECR Repository to push to.

                                    -
                                    encryptionKey: Key

                                    The encryption key use across

                                    -

                                    Settings

                                    Member Visibility

                                    On This Page

                                    Properties
                                    +
                                    pipelineSourcePrefix?: string

                                    The pipeline source prefix

                                    +
                                    pipelineArtifactBucket: Bucket

                                    Artifact bucket to use

                                    +
                                    ecrRepository: IRepository

                                    The ECR Repository to push to.

                                    +
                                    encryptionKey: Key

                                    The encryption key use across

                                    +

                                    Settings

                                    Member Visibility

                                    On This Page

                                    Properties
                                    diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 7f54240..ff225c7 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                    aws4embeddedlinux-cdk-lib
                                      Preparing search index...

                                      Interface EmbeddedLinuxCodePipelineProps

                                      Properties to allow customizing the build.

                                      -
                                      interface EmbeddedLinuxCodePipelineProps {
                                          description?: string;
                                          env?: Environment;
                                          stackName?: string;
                                          tags?: { [key: string]: string };
                                          notificationArns?: string[];
                                          synthesizer?: IStackSynthesizer;
                                          terminationProtection?: boolean;
                                          analyticsReporting?: boolean;
                                          crossRegionReferences?: boolean;
                                          permissionsBoundary?: PermissionsBoundary;
                                          suppressTemplateIndentation?: boolean;
                                          pipelineSourceBucket: IBucket;
                                          pipelineSourcePrefix?: string;
                                          pipelineArtifactBucket: Bucket;
                                          pipelineArtifactPrefix?: string;
                                          pipelineOutputBucket: Bucket;
                                          pipelineOutputPrefix?: string;
                                          ecrRepository: IRepository;
                                          ecrRepositoryImageTag: string;
                                          projectType: ProjectType;
                                          vpc: IVpc;
                                          buildPolicyAdditions?: PolicyStatement[];
                                          environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                          encryptionKey: Key;
                                          sourceCustomPath?: string;
                                      }

                                      Hierarchy

                                      • StackProps
                                        • EmbeddedLinuxCodePipelineProps
                                      Index

                                      Properties

                                      description? +
                                      interface EmbeddedLinuxCodePipelineProps {
                                          description?: string;
                                          env?: Environment;
                                          stackName?: string;
                                          tags?: { [key: string]: string };
                                          notificationArns?: string[];
                                          synthesizer?: IStackSynthesizer;
                                          terminationProtection?: boolean;
                                          analyticsReporting?: boolean;
                                          crossRegionReferences?: boolean;
                                          permissionsBoundary?: PermissionsBoundary;
                                          suppressTemplateIndentation?: boolean;
                                          pipelineSourceBucket: IBucket;
                                          pipelineSourcePrefix?: string;
                                          pipelineArtifactBucket: Bucket;
                                          pipelineArtifactPrefix?: string;
                                          pipelineOutputBucket: Bucket;
                                          pipelineOutputPrefix?: string;
                                          ecrRepository: IRepository;
                                          ecrRepositoryImageTag: string;
                                          projectType: ProjectType;
                                          vpc: IVpc;
                                          buildPolicyAdditions?: PolicyStatement[];
                                          environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                          encryptionKey: Key;
                                          sourceCustomPath?: string;
                                      }

                                      Hierarchy

                                      • StackProps
                                        • EmbeddedLinuxCodePipelineProps
                                      Index

                                      Properties

                                      description? env? stackName? tags? @@ -104,17 +104,17 @@
                                    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                      • pipelineSourceBucket: IBucket

                                      The pipeline source bucket

                                      -
                                      pipelineSourcePrefix?: string

                                      The pipeline source prefix

                                      -
                                      pipelineArtifactBucket: Bucket

                                      The pipeline artifact bucket to use

                                      -
                                      pipelineArtifactPrefix?: string

                                      The pipeline artifact bucket prefix to use

                                      -
                                      pipelineOutputBucket: Bucket

                                      The pipeline output bucket to use

                                      -
                                      pipelineOutputPrefix?: string

                                      The pipeline output bucket prefix to use

                                      -
                                      ecrRepository: IRepository

                                      ECR Repository where the Build Host Image resides.

                                      -
                                      ecrRepositoryImageTag: string

                                      Tag for the Build Host Image

                                      -
                                      projectType: ProjectType

                                      The type of project being built.

                                      -
                                      vpc: IVpc

                                      VPC where the networking setup resides.

                                      -
                                      buildPolicyAdditions?: PolicyStatement[]

                                      Additional policy statements to add to the build project.

                                      -
                                      environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                      Additional build environment variables to the build project.

                                      -
                                      encryptionKey: Key

                                      The encryption key use across

                                      -
                                      sourceCustomPath?: string

                                      Custom asset to be provided when using ProjectType.Custom

                                      -

                                      Settings

                                      Member Visibility

                                      On This Page

                                      Properties
                                      +
                                      pipelineSourcePrefix?: string

                                      The pipeline source prefix

                                      +
                                      pipelineArtifactBucket: Bucket

                                      The pipeline artifact bucket to use

                                      +
                                      pipelineArtifactPrefix?: string

                                      The pipeline artifact bucket prefix to use

                                      +
                                      pipelineOutputBucket: Bucket

                                      The pipeline output bucket to use

                                      +
                                      pipelineOutputPrefix?: string

                                      The pipeline output bucket prefix to use

                                      +
                                      ecrRepository: IRepository

                                      ECR Repository where the Build Host Image resides.

                                      +
                                      ecrRepositoryImageTag: string

                                      Tag for the Build Host Image

                                      +
                                      projectType: ProjectType

                                      The type of project being built.

                                      +
                                      vpc: IVpc

                                      VPC where the networking setup resides.

                                      +
                                      buildPolicyAdditions?: PolicyStatement[]

                                      Additional policy statements to add to the build project.

                                      +
                                      environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                      Additional build environment variables to the build project.

                                      +
                                      encryptionKey: Key

                                      The encryption key use across

                                      +
                                      sourceCustomPath?: string

                                      Custom asset to be provided when using ProjectType.Custom

                                      +

                                      Settings

                                      Member Visibility

                                      On This Page

                                      Properties
                                      diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 5371f9c..f34b911 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                      aws4embeddedlinux-cdk-lib
                                        Preparing search index...

                                        Interface PipelineResourcesProps

                                        Select options for the PipelineResourcesStack.

                                        -
                                        interface PipelineResourcesProps {
                                            description?: string;
                                            env?: Environment;
                                            stackName?: string;
                                            tags?: { [key: string]: string };
                                            notificationArns?: string[];
                                            synthesizer?: IStackSynthesizer;
                                            terminationProtection?: boolean;
                                            analyticsReporting?: boolean;
                                            crossRegionReferences?: boolean;
                                            permissionsBoundary?: PermissionsBoundary;
                                            suppressTemplateIndentation?: boolean;
                                            resource_prefix: string;
                                            ecrRepositoryName?: string;
                                            pipelineArtifactBucketName?: string;
                                            pipelineSourceBucketName?: string;
                                            pipelineOutputBucketName?: string;
                                            loggingBucketName?: string;
                                        }

                                        Hierarchy

                                        • StackProps
                                          • PipelineResourcesProps
                                        Index

                                        Properties

                                        description? +
                                        interface PipelineResourcesProps {
                                            description?: string;
                                            env?: Environment;
                                            stackName?: string;
                                            tags?: { [key: string]: string };
                                            notificationArns?: string[];
                                            synthesizer?: IStackSynthesizer;
                                            terminationProtection?: boolean;
                                            analyticsReporting?: boolean;
                                            crossRegionReferences?: boolean;
                                            permissionsBoundary?: PermissionsBoundary;
                                            suppressTemplateIndentation?: boolean;
                                            resource_prefix: string;
                                            ecrRepositoryName?: string;
                                            pipelineArtifactBucketName?: string;
                                            pipelineSourceBucketName?: string;
                                            pipelineOutputBucketName?: string;
                                            loggingBucketName?: string;
                                        }

                                        Hierarchy

                                        • StackProps
                                          • PipelineResourcesProps
                                        Index

                                        Properties

                                        description? env? stackName? tags? @@ -96,9 +96,9 @@
                                      • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                        • resource_prefix: string

                                        The resource prefix

                                        -
                                        ecrRepositoryName?: string

                                        The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                        -
                                        pipelineArtifactBucketName?: string

                                        The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                        -
                                        pipelineSourceBucketName?: string

                                        The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                        -
                                        pipelineOutputBucketName?: string

                                        The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                        -
                                        loggingBucketName?: string

                                        Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                        -

                                        Settings

                                        Member Visibility

                                        On This Page

                                        Properties
                                        +
                                        ecrRepositoryName?: string

                                        The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                        +
                                        pipelineArtifactBucketName?: string

                                        The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                        +
                                        pipelineSourceBucketName?: string

                                        The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                        +
                                        pipelineOutputBucketName?: string

                                        The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                        +
                                        loggingBucketName?: string

                                        Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                        +

                                        Settings

                                        Member Visibility

                                        On This Page

                                        Properties
                                        From abcd217aaebbb87a06b8c3b5a4602840484a6e6c Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 15 Jul 2025 05:24:42 +0000 Subject: [PATCH 31/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@fb91ec609e3c7c49ebb4e879f9?= =?UTF-8?q?d0cc09356eec9e=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 9f8cf16..e7b9df6 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                        aws4embeddedlinux-cdk-lib
                                          Preparing search index...

                                          Class EmbeddedLinuxCodeBuildProjectStack

                                          The stack for creating a build pipeline.

                                          See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                          -

                                          Hierarchy

                                          • Stack
                                            • EmbeddedLinuxCodeBuildProjectStack
                                          Index

                                          Constructors

                                          constructor +

                                          Hierarchy

                                          • Stack
                                            • EmbeddedLinuxCodeBuildProjectStack
                                          Index

                                          Constructors

                                          constructor

                                          Properties

                                          tags templateOptions region @@ -50,7 +50,7 @@ _toCloudFormation isConstruct toString -

                                          Constructors

                                          Properties

                                          tags: TagManager

                                          Tags to be applied to the stack.

                                          +

                                          Constructors

                                          Properties

                                          tags: TagManager

                                          Tags to be applied to the stack.

                                          templateOptions: ITemplateOptions

                                          Options for CloudFormation template (like version, transform, description).

                                          region: string

                                          The AWS region into which this stack will be deployed (e.g. us-west-2).

                                          This value is resolved according to the following rules:

                                          diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 8d29a16..50925f9 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                          aws4embeddedlinux-cdk-lib
                                            Preparing search index...

                                            Class EmbeddedLinuxCodePipelineBaseImageStack

                                            The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                            For configuration options see BuildBaseImageCodePipelineProps.

                                            -

                                            Hierarchy

                                            • Stack
                                              • EmbeddedLinuxCodePipelineBaseImageStack
                                            Index

                                            Constructors

                                            constructor +

                                            Hierarchy

                                            • Stack
                                              • EmbeddedLinuxCodePipelineBaseImageStack
                                            Index

                                            Constructors

                                            constructor

                                            Properties

                                            tags templateOptions region @@ -53,7 +53,7 @@ _toCloudFormation isConstruct toString -

                                            Constructors

                                            Properties

                                            tags: TagManager

                                            Tags to be applied to the stack.

                                            +

                                            Constructors

                                            Properties

                                            tags: TagManager

                                            Tags to be applied to the stack.

                                            templateOptions: ITemplateOptions

                                            Options for CloudFormation template (like version, transform, description).

                                            region: string

                                            The AWS region into which this stack will be deployed (e.g. us-west-2).

                                            This value is resolved according to the following rules:

                                            @@ -110,8 +110,8 @@

                                            Readonly Internal_crossRegionReferences

                                            _crossRegionReferences: boolean

                                            Whether cross region references are enabled for this stack

                                            Optional Readonly Internal_notificationArns

                                            _notificationArns?: string[]

                                            SNS Notification ARNs to receive stack events.

                                            ecrRepository: IRepository

                                            The ECR Repository where the image is located.

                                            -
                                            ecrRepositoryImageTag: string

                                            The ECR Image Tag to find the base imaged.

                                            -
                                            node: Node

                                            The tree node.

                                            +
                                            ecrRepositoryImageTag: string

                                            The ECR Image Tag to find the base imaged.

                                            +
                                            node: Node

                                            The tree node.

                                            Accessors

                                            • get terminationProtection(): boolean

                                              Whether termination protection is enabled for this stack.

                                              Returns boolean

                                            • set terminationProtection(value: boolean): void

                                              Parameters

                                              • value: boolean

                                              Returns void

                                            • get dependencies(): Stack[]

                                              Return the stacks this stack depends on

                                              Returns Stack[]

                                            ecrRepository: IRepository

                                            ECR Repository where the Build Host Image resides.

                                            -
                                            ecrRepositoryImageTag: string

                                            Tag for the Build Host Image

                                            -
                                            vpc: IVpc

                                            VPC where the networking setup resides.

                                            -
                                            buildPolicyAdditions?: PolicyStatement[]

                                            Additional policy statements to add to the build project.

                                            -
                                            encryptionKey: Key

                                            The encryption key use across

                                            -

                                            Settings

                                            Member Visibility

                                            On This Page

                                            Properties
                                            +
                                            ecrRepositoryImageTag: string

                                            Tag for the Build Host Image

                                            +
                                            vpc: IVpc

                                            VPC where the networking setup resides.

                                            +
                                            buildPolicyAdditions?: PolicyStatement[]

                                            Additional policy statements to add to the build project.

                                            +
                                            encryptionKey: Key

                                            The encryption key use across

                                            +

                                            Settings

                                            Member Visibility

                                            On This Page

                                            Properties
                                            diff --git a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html index d211ccc..f9eeefb 100644 --- a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineBaseImageProps | aws4embeddedlinux-cdk-lib
                                            aws4embeddedlinux-cdk-lib
                                              Preparing search index...

                                              Interface EmbeddedLinuxCodePipelineBaseImageProps

                                              Select options for the BuildImageCodePipelineStack.

                                              -
                                              interface EmbeddedLinuxCodePipelineBaseImageProps {
                                                  description?: string;
                                                  env?: Environment;
                                                  stackName?: string;
                                                  tags?: { [key: string]: string };
                                                  notificationArns?: string[];
                                                  synthesizer?: IStackSynthesizer;
                                                  terminationProtection?: boolean;
                                                  analyticsReporting?: boolean;
                                                  crossRegionReferences?: boolean;
                                                  permissionsBoundary?: PermissionsBoundary;
                                                  suppressTemplateIndentation?: boolean;
                                                  pipelineSourceBucket: IBucket;
                                                  pipelineSourcePrefix?: string;
                                                  pipelineArtifactBucket: Bucket;
                                                  ecrRepository: IRepository;
                                                  encryptionKey: Key;
                                              }

                                              Hierarchy

                                              • StackProps
                                                • EmbeddedLinuxCodePipelineBaseImageProps
                                              Index

                                              Properties

                                              description? +
                                              interface EmbeddedLinuxCodePipelineBaseImageProps {
                                                  description?: string;
                                                  env?: Environment;
                                                  stackName?: string;
                                                  tags?: { [key: string]: string };
                                                  notificationArns?: string[];
                                                  synthesizer?: IStackSynthesizer;
                                                  terminationProtection?: boolean;
                                                  analyticsReporting?: boolean;
                                                  crossRegionReferences?: boolean;
                                                  permissionsBoundary?: PermissionsBoundary;
                                                  suppressTemplateIndentation?: boolean;
                                                  pipelineSourceBucket: IBucket;
                                                  pipelineSourcePrefix?: string;
                                                  pipelineArtifactBucket: Bucket;
                                                  ecrRepository: IRepository;
                                                  encryptionKey: Key;
                                              }

                                              Hierarchy

                                              • StackProps
                                                • EmbeddedLinuxCodePipelineBaseImageProps
                                              Index

                                              Properties

                                              description? env? stackName? tags? @@ -95,8 +95,8 @@
                                            • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                              • pipelineSourceBucket: IBucket

                                              The pipeline source bucket

                                              -
                                              pipelineSourcePrefix?: string

                                              The pipeline source prefix

                                              -
                                              pipelineArtifactBucket: Bucket

                                              Artifact bucket to use

                                              -
                                              ecrRepository: IRepository

                                              The ECR Repository to push to.

                                              -
                                              encryptionKey: Key

                                              The encryption key use across

                                              -

                                              Settings

                                              Member Visibility

                                              On This Page

                                              Properties
                                              +
                                              pipelineSourcePrefix?: string

                                              The pipeline source prefix

                                              +
                                              pipelineArtifactBucket: Bucket

                                              Artifact bucket to use

                                              +
                                              ecrRepository: IRepository

                                              The ECR Repository to push to.

                                              +
                                              encryptionKey: Key

                                              The encryption key use across

                                              +

                                              Settings

                                              Member Visibility

                                              On This Page

                                              Properties
                                              diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index ff225c7..8ce2b9a 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                              aws4embeddedlinux-cdk-lib
                                                Preparing search index...

                                                Interface EmbeddedLinuxCodePipelineProps

                                                Properties to allow customizing the build.

                                                -
                                                interface EmbeddedLinuxCodePipelineProps {
                                                    description?: string;
                                                    env?: Environment;
                                                    stackName?: string;
                                                    tags?: { [key: string]: string };
                                                    notificationArns?: string[];
                                                    synthesizer?: IStackSynthesizer;
                                                    terminationProtection?: boolean;
                                                    analyticsReporting?: boolean;
                                                    crossRegionReferences?: boolean;
                                                    permissionsBoundary?: PermissionsBoundary;
                                                    suppressTemplateIndentation?: boolean;
                                                    pipelineSourceBucket: IBucket;
                                                    pipelineSourcePrefix?: string;
                                                    pipelineArtifactBucket: Bucket;
                                                    pipelineArtifactPrefix?: string;
                                                    pipelineOutputBucket: Bucket;
                                                    pipelineOutputPrefix?: string;
                                                    ecrRepository: IRepository;
                                                    ecrRepositoryImageTag: string;
                                                    projectType: ProjectType;
                                                    vpc: IVpc;
                                                    buildPolicyAdditions?: PolicyStatement[];
                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                    encryptionKey: Key;
                                                    sourceCustomPath?: string;
                                                }

                                                Hierarchy

                                                • StackProps
                                                  • EmbeddedLinuxCodePipelineProps
                                                Index

                                                Properties

                                                description? +
                                                interface EmbeddedLinuxCodePipelineProps {
                                                    description?: string;
                                                    env?: Environment;
                                                    stackName?: string;
                                                    tags?: { [key: string]: string };
                                                    notificationArns?: string[];
                                                    synthesizer?: IStackSynthesizer;
                                                    terminationProtection?: boolean;
                                                    analyticsReporting?: boolean;
                                                    crossRegionReferences?: boolean;
                                                    permissionsBoundary?: PermissionsBoundary;
                                                    suppressTemplateIndentation?: boolean;
                                                    pipelineSourceBucket: IBucket;
                                                    pipelineSourcePrefix?: string;
                                                    pipelineArtifactBucket: Bucket;
                                                    pipelineArtifactPrefix?: string;
                                                    pipelineOutputBucket: Bucket;
                                                    pipelineOutputPrefix?: string;
                                                    ecrRepository: IRepository;
                                                    ecrRepositoryImageTag: string;
                                                    projectType: ProjectType;
                                                    vpc: IVpc;
                                                    buildPolicyAdditions?: PolicyStatement[];
                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                    encryptionKey: Key;
                                                    sourceCustomPath?: string;
                                                }

                                                Hierarchy

                                                • StackProps
                                                  • EmbeddedLinuxCodePipelineProps
                                                Index

                                                Properties

                                                description? env? stackName? tags? @@ -104,17 +104,17 @@
                                              • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                                • pipelineSourceBucket: IBucket

                                                The pipeline source bucket

                                                -
                                                pipelineSourcePrefix?: string

                                                The pipeline source prefix

                                                -
                                                pipelineArtifactBucket: Bucket

                                                The pipeline artifact bucket to use

                                                -
                                                pipelineArtifactPrefix?: string

                                                The pipeline artifact bucket prefix to use

                                                -
                                                pipelineOutputBucket: Bucket

                                                The pipeline output bucket to use

                                                -
                                                pipelineOutputPrefix?: string

                                                The pipeline output bucket prefix to use

                                                -
                                                ecrRepository: IRepository

                                                ECR Repository where the Build Host Image resides.

                                                -
                                                ecrRepositoryImageTag: string

                                                Tag for the Build Host Image

                                                -
                                                projectType: ProjectType

                                                The type of project being built.

                                                -
                                                vpc: IVpc

                                                VPC where the networking setup resides.

                                                -
                                                buildPolicyAdditions?: PolicyStatement[]

                                                Additional policy statements to add to the build project.

                                                -
                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                Additional build environment variables to the build project.

                                                -
                                                encryptionKey: Key

                                                The encryption key use across

                                                -
                                                sourceCustomPath?: string

                                                Custom asset to be provided when using ProjectType.Custom

                                                -

                                                Settings

                                                Member Visibility

                                                On This Page

                                                Properties
                                                +
                                                pipelineSourcePrefix?: string

                                                The pipeline source prefix

                                                +
                                                pipelineArtifactBucket: Bucket

                                                The pipeline artifact bucket to use

                                                +
                                                pipelineArtifactPrefix?: string

                                                The pipeline artifact bucket prefix to use

                                                +
                                                pipelineOutputBucket: Bucket

                                                The pipeline output bucket to use

                                                +
                                                pipelineOutputPrefix?: string

                                                The pipeline output bucket prefix to use

                                                +
                                                ecrRepository: IRepository

                                                ECR Repository where the Build Host Image resides.

                                                +
                                                ecrRepositoryImageTag: string

                                                Tag for the Build Host Image

                                                +
                                                projectType: ProjectType

                                                The type of project being built.

                                                +
                                                vpc: IVpc

                                                VPC where the networking setup resides.

                                                +
                                                buildPolicyAdditions?: PolicyStatement[]

                                                Additional policy statements to add to the build project.

                                                +
                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                Additional build environment variables to the build project.

                                                +
                                                encryptionKey: Key

                                                The encryption key use across

                                                +
                                                sourceCustomPath?: string

                                                Custom asset to be provided when using ProjectType.Custom

                                                +

                                                Settings

                                                Member Visibility

                                                On This Page

                                                Properties
                                                diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index f34b911..ef6432c 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                aws4embeddedlinux-cdk-lib
                                                  Preparing search index...

                                                  Interface PipelineResourcesProps

                                                  Select options for the PipelineResourcesStack.

                                                  -
                                                  interface PipelineResourcesProps {
                                                      description?: string;
                                                      env?: Environment;
                                                      stackName?: string;
                                                      tags?: { [key: string]: string };
                                                      notificationArns?: string[];
                                                      synthesizer?: IStackSynthesizer;
                                                      terminationProtection?: boolean;
                                                      analyticsReporting?: boolean;
                                                      crossRegionReferences?: boolean;
                                                      permissionsBoundary?: PermissionsBoundary;
                                                      suppressTemplateIndentation?: boolean;
                                                      resource_prefix: string;
                                                      ecrRepositoryName?: string;
                                                      pipelineArtifactBucketName?: string;
                                                      pipelineSourceBucketName?: string;
                                                      pipelineOutputBucketName?: string;
                                                      loggingBucketName?: string;
                                                  }

                                                  Hierarchy

                                                  • StackProps
                                                    • PipelineResourcesProps
                                                  Index

                                                  Properties

                                                  description? +
                                                  interface PipelineResourcesProps {
                                                      description?: string;
                                                      env?: Environment;
                                                      stackName?: string;
                                                      tags?: { [key: string]: string };
                                                      notificationArns?: string[];
                                                      synthesizer?: IStackSynthesizer;
                                                      terminationProtection?: boolean;
                                                      analyticsReporting?: boolean;
                                                      crossRegionReferences?: boolean;
                                                      permissionsBoundary?: PermissionsBoundary;
                                                      suppressTemplateIndentation?: boolean;
                                                      resource_prefix: string;
                                                      ecrRepositoryName?: string;
                                                      pipelineArtifactBucketName?: string;
                                                      pipelineSourceBucketName?: string;
                                                      pipelineOutputBucketName?: string;
                                                      loggingBucketName?: string;
                                                  }

                                                  Hierarchy

                                                  • StackProps
                                                    • PipelineResourcesProps
                                                  Index

                                                  Properties

                                                  description? env? stackName? tags? @@ -96,9 +96,9 @@
                                                • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                                  • resource_prefix: string

                                                  The resource prefix

                                                  -
                                                  ecrRepositoryName?: string

                                                  The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                  -
                                                  pipelineArtifactBucketName?: string

                                                  The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                  -
                                                  pipelineSourceBucketName?: string

                                                  The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                  -
                                                  pipelineOutputBucketName?: string

                                                  The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                  -
                                                  loggingBucketName?: string

                                                  Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                  -

                                                  Settings

                                                  Member Visibility

                                                  On This Page

                                                  Properties
                                                  +
                                                  ecrRepositoryName?: string

                                                  The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                  +
                                                  pipelineArtifactBucketName?: string

                                                  The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                  +
                                                  pipelineSourceBucketName?: string

                                                  The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                  +
                                                  pipelineOutputBucketName?: string

                                                  The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                  +
                                                  loggingBucketName?: string

                                                  Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                  +

                                                  Settings

                                                  Member Visibility

                                                  On This Page

                                                  Properties
                                                  From fe15ec148b079f6c8c79a21324efab4c5162f737 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 15 Jul 2025 05:24:52 +0000 Subject: [PATCH 32/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@c634a4ec3b0c6937121602d3de?= =?UTF-8?q?42e7a33d564193=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index e7b9df6..90aed04 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                  aws4embeddedlinux-cdk-lib
                                                    Preparing search index...

                                                    Class EmbeddedLinuxCodeBuildProjectStack

                                                    The stack for creating a build pipeline.

                                                    See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                    -

                                                    Hierarchy

                                                    • Stack
                                                      • EmbeddedLinuxCodeBuildProjectStack
                                                    Index

                                                    Constructors

                                                    constructor +

                                                    Hierarchy

                                                    • Stack
                                                      • EmbeddedLinuxCodeBuildProjectStack
                                                    Index

                                                    Constructors

                                                    constructor

                                                    Properties

                                                    tags templateOptions region @@ -50,7 +50,7 @@ _toCloudFormation isConstruct toString -

                                                    Constructors

                                                    Properties

                                                    tags: TagManager

                                                    Tags to be applied to the stack.

                                                    +

                                                    Constructors

                                                    Properties

                                                    tags: TagManager

                                                    Tags to be applied to the stack.

                                                    templateOptions: ITemplateOptions

                                                    Options for CloudFormation template (like version, transform, description).

                                                    region: string

                                                    The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                    This value is resolved according to the following rules:

                                                    diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 50925f9..59dc74d 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                    aws4embeddedlinux-cdk-lib
                                                      Preparing search index...

                                                      Class EmbeddedLinuxCodePipelineBaseImageStack

                                                      The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                      For configuration options see BuildBaseImageCodePipelineProps.

                                                      -

                                                      Hierarchy

                                                      • Stack
                                                        • EmbeddedLinuxCodePipelineBaseImageStack
                                                      Index

                                                      Constructors

                                                      constructor +

                                                      Hierarchy

                                                      • Stack
                                                        • EmbeddedLinuxCodePipelineBaseImageStack
                                                      Index

                                                      Constructors

                                                      constructor

                                                      Properties

                                                      tags templateOptions region @@ -53,7 +53,7 @@ _toCloudFormation isConstruct toString -

                                                      Constructors

                                                      Properties

                                                      tags: TagManager

                                                      Tags to be applied to the stack.

                                                      +

                                                      Constructors

                                                      Properties

                                                      tags: TagManager

                                                      Tags to be applied to the stack.

                                                      templateOptions: ITemplateOptions

                                                      Options for CloudFormation template (like version, transform, description).

                                                      region: string

                                                      The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                      This value is resolved according to the following rules:

                                                      @@ -110,8 +110,8 @@

                                                      Readonly Internal_crossRegionReferences

                                                      _crossRegionReferences: boolean

                                                      Whether cross region references are enabled for this stack

                                                      Optional Readonly Internal_notificationArns

                                                      _notificationArns?: string[]

                                                      SNS Notification ARNs to receive stack events.

                                                      ecrRepository: IRepository

                                                      The ECR Repository where the image is located.

                                                      -
                                                      ecrRepositoryImageTag: string

                                                      The ECR Image Tag to find the base imaged.

                                                      -
                                                      node: Node

                                                      The tree node.

                                                      +
                                                      ecrRepositoryImageTag: string

                                                      The ECR Image Tag to find the base imaged.

                                                      +
                                                      node: Node

                                                      The tree node.

                                                      Accessors

                                                      • get terminationProtection(): boolean

                                                        Whether termination protection is enabled for this stack.

                                                        Returns boolean

                                                      • set terminationProtection(value: boolean): void

                                                        Parameters

                                                        • value: boolean

                                                        Returns void

                                                      • get dependencies(): Stack[]

                                                        Return the stacks this stack depends on

                                                        Returns Stack[]

                                                      ecrRepository: IRepository

                                                      ECR Repository where the Build Host Image resides.

                                                      -
                                                      ecrRepositoryImageTag: string

                                                      Tag for the Build Host Image

                                                      -
                                                      vpc: IVpc

                                                      VPC where the networking setup resides.

                                                      -
                                                      buildPolicyAdditions?: PolicyStatement[]

                                                      Additional policy statements to add to the build project.

                                                      -
                                                      encryptionKey: Key

                                                      The encryption key use across

                                                      -

                                                      Settings

                                                      Member Visibility

                                                      On This Page

                                                      Properties
                                                      +
                                                      ecrRepositoryImageTag: string

                                                      Tag for the Build Host Image

                                                      +
                                                      vpc: IVpc

                                                      VPC where the networking setup resides.

                                                      +
                                                      buildPolicyAdditions?: PolicyStatement[]

                                                      Additional policy statements to add to the build project.

                                                      +
                                                      encryptionKey: Key

                                                      The encryption key use across

                                                      +

                                                      Settings

                                                      Member Visibility

                                                      On This Page

                                                      Properties
                                                      diff --git a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html index f9eeefb..da913fc 100644 --- a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineBaseImageProps | aws4embeddedlinux-cdk-lib
                                                      aws4embeddedlinux-cdk-lib
                                                        Preparing search index...

                                                        Interface EmbeddedLinuxCodePipelineBaseImageProps

                                                        Select options for the BuildImageCodePipelineStack.

                                                        -
                                                        interface EmbeddedLinuxCodePipelineBaseImageProps {
                                                            description?: string;
                                                            env?: Environment;
                                                            stackName?: string;
                                                            tags?: { [key: string]: string };
                                                            notificationArns?: string[];
                                                            synthesizer?: IStackSynthesizer;
                                                            terminationProtection?: boolean;
                                                            analyticsReporting?: boolean;
                                                            crossRegionReferences?: boolean;
                                                            permissionsBoundary?: PermissionsBoundary;
                                                            suppressTemplateIndentation?: boolean;
                                                            pipelineSourceBucket: IBucket;
                                                            pipelineSourcePrefix?: string;
                                                            pipelineArtifactBucket: Bucket;
                                                            ecrRepository: IRepository;
                                                            encryptionKey: Key;
                                                        }

                                                        Hierarchy

                                                        • StackProps
                                                          • EmbeddedLinuxCodePipelineBaseImageProps
                                                        Index

                                                        Properties

                                                        description? +
                                                        interface EmbeddedLinuxCodePipelineBaseImageProps {
                                                            description?: string;
                                                            env?: Environment;
                                                            stackName?: string;
                                                            tags?: { [key: string]: string };
                                                            notificationArns?: string[];
                                                            synthesizer?: IStackSynthesizer;
                                                            terminationProtection?: boolean;
                                                            analyticsReporting?: boolean;
                                                            crossRegionReferences?: boolean;
                                                            permissionsBoundary?: PermissionsBoundary;
                                                            suppressTemplateIndentation?: boolean;
                                                            pipelineSourceBucket: IBucket;
                                                            pipelineSourcePrefix?: string;
                                                            pipelineArtifactBucket: Bucket;
                                                            ecrRepository: IRepository;
                                                            encryptionKey: Key;
                                                        }

                                                        Hierarchy

                                                        • StackProps
                                                          • EmbeddedLinuxCodePipelineBaseImageProps
                                                        Index

                                                        Properties

                                                        description? env? stackName? tags? @@ -95,8 +95,8 @@
                                                      • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                                        • pipelineSourceBucket: IBucket

                                                        The pipeline source bucket

                                                        -
                                                        pipelineSourcePrefix?: string

                                                        The pipeline source prefix

                                                        -
                                                        pipelineArtifactBucket: Bucket

                                                        Artifact bucket to use

                                                        -
                                                        ecrRepository: IRepository

                                                        The ECR Repository to push to.

                                                        -
                                                        encryptionKey: Key

                                                        The encryption key use across

                                                        -

                                                        Settings

                                                        Member Visibility

                                                        On This Page

                                                        Properties
                                                        +
                                                        pipelineSourcePrefix?: string

                                                        The pipeline source prefix

                                                        +
                                                        pipelineArtifactBucket: Bucket

                                                        Artifact bucket to use

                                                        +
                                                        ecrRepository: IRepository

                                                        The ECR Repository to push to.

                                                        +
                                                        encryptionKey: Key

                                                        The encryption key use across

                                                        +

                                                        Settings

                                                        Member Visibility

                                                        On This Page

                                                        Properties
                                                        diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 8ce2b9a..fea3521 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                        aws4embeddedlinux-cdk-lib
                                                          Preparing search index...

                                                          Interface EmbeddedLinuxCodePipelineProps

                                                          Properties to allow customizing the build.

                                                          -
                                                          interface EmbeddedLinuxCodePipelineProps {
                                                              description?: string;
                                                              env?: Environment;
                                                              stackName?: string;
                                                              tags?: { [key: string]: string };
                                                              notificationArns?: string[];
                                                              synthesizer?: IStackSynthesizer;
                                                              terminationProtection?: boolean;
                                                              analyticsReporting?: boolean;
                                                              crossRegionReferences?: boolean;
                                                              permissionsBoundary?: PermissionsBoundary;
                                                              suppressTemplateIndentation?: boolean;
                                                              pipelineSourceBucket: IBucket;
                                                              pipelineSourcePrefix?: string;
                                                              pipelineArtifactBucket: Bucket;
                                                              pipelineArtifactPrefix?: string;
                                                              pipelineOutputBucket: Bucket;
                                                              pipelineOutputPrefix?: string;
                                                              ecrRepository: IRepository;
                                                              ecrRepositoryImageTag: string;
                                                              projectType: ProjectType;
                                                              vpc: IVpc;
                                                              buildPolicyAdditions?: PolicyStatement[];
                                                              environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                              encryptionKey: Key;
                                                              sourceCustomPath?: string;
                                                          }

                                                          Hierarchy

                                                          • StackProps
                                                            • EmbeddedLinuxCodePipelineProps
                                                          Index

                                                          Properties

                                                          description? +
                                                          interface EmbeddedLinuxCodePipelineProps {
                                                              description?: string;
                                                              env?: Environment;
                                                              stackName?: string;
                                                              tags?: { [key: string]: string };
                                                              notificationArns?: string[];
                                                              synthesizer?: IStackSynthesizer;
                                                              terminationProtection?: boolean;
                                                              analyticsReporting?: boolean;
                                                              crossRegionReferences?: boolean;
                                                              permissionsBoundary?: PermissionsBoundary;
                                                              suppressTemplateIndentation?: boolean;
                                                              pipelineSourceBucket: IBucket;
                                                              pipelineSourcePrefix?: string;
                                                              pipelineArtifactBucket: Bucket;
                                                              pipelineArtifactPrefix?: string;
                                                              pipelineOutputBucket: Bucket;
                                                              pipelineOutputPrefix?: string;
                                                              ecrRepository: IRepository;
                                                              ecrRepositoryImageTag: string;
                                                              projectType: ProjectType;
                                                              vpc: IVpc;
                                                              buildPolicyAdditions?: PolicyStatement[];
                                                              environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                              encryptionKey: Key;
                                                              sourceCustomPath?: string;
                                                          }

                                                          Hierarchy

                                                          • StackProps
                                                            • EmbeddedLinuxCodePipelineProps
                                                          Index

                                                          Properties

                                                          description? env? stackName? tags? @@ -104,17 +104,17 @@
                                                        • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                                          • pipelineSourceBucket: IBucket

                                                          The pipeline source bucket

                                                          -
                                                          pipelineSourcePrefix?: string

                                                          The pipeline source prefix

                                                          -
                                                          pipelineArtifactBucket: Bucket

                                                          The pipeline artifact bucket to use

                                                          -
                                                          pipelineArtifactPrefix?: string

                                                          The pipeline artifact bucket prefix to use

                                                          -
                                                          pipelineOutputBucket: Bucket

                                                          The pipeline output bucket to use

                                                          -
                                                          pipelineOutputPrefix?: string

                                                          The pipeline output bucket prefix to use

                                                          -
                                                          ecrRepository: IRepository

                                                          ECR Repository where the Build Host Image resides.

                                                          -
                                                          ecrRepositoryImageTag: string

                                                          Tag for the Build Host Image

                                                          -
                                                          projectType: ProjectType

                                                          The type of project being built.

                                                          -
                                                          vpc: IVpc

                                                          VPC where the networking setup resides.

                                                          -
                                                          buildPolicyAdditions?: PolicyStatement[]

                                                          Additional policy statements to add to the build project.

                                                          -
                                                          environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                          Additional build environment variables to the build project.

                                                          -
                                                          encryptionKey: Key

                                                          The encryption key use across

                                                          -
                                                          sourceCustomPath?: string

                                                          Custom asset to be provided when using ProjectType.Custom

                                                          -

                                                          Settings

                                                          Member Visibility

                                                          On This Page

                                                          Properties
                                                          +
                                                          pipelineSourcePrefix?: string

                                                          The pipeline source prefix

                                                          +
                                                          pipelineArtifactBucket: Bucket

                                                          The pipeline artifact bucket to use

                                                          +
                                                          pipelineArtifactPrefix?: string

                                                          The pipeline artifact bucket prefix to use

                                                          +
                                                          pipelineOutputBucket: Bucket

                                                          The pipeline output bucket to use

                                                          +
                                                          pipelineOutputPrefix?: string

                                                          The pipeline output bucket prefix to use

                                                          +
                                                          ecrRepository: IRepository

                                                          ECR Repository where the Build Host Image resides.

                                                          +
                                                          ecrRepositoryImageTag: string

                                                          Tag for the Build Host Image

                                                          +
                                                          projectType: ProjectType

                                                          The type of project being built.

                                                          +
                                                          vpc: IVpc

                                                          VPC where the networking setup resides.

                                                          +
                                                          buildPolicyAdditions?: PolicyStatement[]

                                                          Additional policy statements to add to the build project.

                                                          +
                                                          environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                          Additional build environment variables to the build project.

                                                          +
                                                          encryptionKey: Key

                                                          The encryption key use across

                                                          +
                                                          sourceCustomPath?: string

                                                          Custom asset to be provided when using ProjectType.Custom

                                                          +

                                                          Settings

                                                          Member Visibility

                                                          On This Page

                                                          Properties
                                                          diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index ef6432c..cd8b48d 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                          aws4embeddedlinux-cdk-lib
                                                            Preparing search index...

                                                            Interface PipelineResourcesProps

                                                            Select options for the PipelineResourcesStack.

                                                            -
                                                            interface PipelineResourcesProps {
                                                                description?: string;
                                                                env?: Environment;
                                                                stackName?: string;
                                                                tags?: { [key: string]: string };
                                                                notificationArns?: string[];
                                                                synthesizer?: IStackSynthesizer;
                                                                terminationProtection?: boolean;
                                                                analyticsReporting?: boolean;
                                                                crossRegionReferences?: boolean;
                                                                permissionsBoundary?: PermissionsBoundary;
                                                                suppressTemplateIndentation?: boolean;
                                                                resource_prefix: string;
                                                                ecrRepositoryName?: string;
                                                                pipelineArtifactBucketName?: string;
                                                                pipelineSourceBucketName?: string;
                                                                pipelineOutputBucketName?: string;
                                                                loggingBucketName?: string;
                                                            }

                                                            Hierarchy

                                                            • StackProps
                                                              • PipelineResourcesProps
                                                            Index

                                                            Properties

                                                            description? +
                                                            interface PipelineResourcesProps {
                                                                description?: string;
                                                                env?: Environment;
                                                                stackName?: string;
                                                                tags?: { [key: string]: string };
                                                                notificationArns?: string[];
                                                                synthesizer?: IStackSynthesizer;
                                                                terminationProtection?: boolean;
                                                                analyticsReporting?: boolean;
                                                                crossRegionReferences?: boolean;
                                                                permissionsBoundary?: PermissionsBoundary;
                                                                suppressTemplateIndentation?: boolean;
                                                                resource_prefix: string;
                                                                ecrRepositoryName?: string;
                                                                pipelineArtifactBucketName?: string;
                                                                pipelineSourceBucketName?: string;
                                                                pipelineOutputBucketName?: string;
                                                                loggingBucketName?: string;
                                                            }

                                                            Hierarchy

                                                            • StackProps
                                                              • PipelineResourcesProps
                                                            Index

                                                            Properties

                                                            description? env? stackName? tags? @@ -96,9 +96,9 @@
                                                          • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                                            • resource_prefix: string

                                                            The resource prefix

                                                            -
                                                            ecrRepositoryName?: string

                                                            The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                            -
                                                            pipelineArtifactBucketName?: string

                                                            The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                            -
                                                            pipelineSourceBucketName?: string

                                                            The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                            -
                                                            pipelineOutputBucketName?: string

                                                            The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                            -
                                                            loggingBucketName?: string

                                                            Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                            -

                                                            Settings

                                                            Member Visibility

                                                            On This Page

                                                            Properties
                                                            +
                                                            ecrRepositoryName?: string

                                                            The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                            +
                                                            pipelineArtifactBucketName?: string

                                                            The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                            +
                                                            pipelineSourceBucketName?: string

                                                            The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                            +
                                                            pipelineOutputBucketName?: string

                                                            The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                            +
                                                            loggingBucketName?: string

                                                            Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                            +

                                                            Settings

                                                            Member Visibility

                                                            On This Page

                                                            Properties
                                                            From 2521561ecb903b17ec5ee98dc6a60b24d43c0f46 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 15 Jul 2025 05:34:47 +0000 Subject: [PATCH 33/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@787f7d6e382f466d1247901ff4?= =?UTF-8?q?5a207c41004981=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 90aed04..e9c19c0 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                            aws4embeddedlinux-cdk-lib
                                                              Preparing search index...

                                                              Class EmbeddedLinuxCodeBuildProjectStack

                                                              The stack for creating a build pipeline.

                                                              See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                              -

                                                              Hierarchy

                                                              • Stack
                                                                • EmbeddedLinuxCodeBuildProjectStack
                                                              Index

                                                              Constructors

                                                              constructor +

                                                              Hierarchy

                                                              • Stack
                                                                • EmbeddedLinuxCodeBuildProjectStack
                                                              Index

                                                              Constructors

                                                              constructor

                                                              Properties

                                                              tags templateOptions region @@ -50,7 +50,7 @@ _toCloudFormation isConstruct toString -

                                                              Constructors

                                                              Properties

                                                              tags: TagManager

                                                              Tags to be applied to the stack.

                                                              +

                                                              Constructors

                                                              Properties

                                                              tags: TagManager

                                                              Tags to be applied to the stack.

                                                              templateOptions: ITemplateOptions

                                                              Options for CloudFormation template (like version, transform, description).

                                                              region: string

                                                              The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                              This value is resolved according to the following rules:

                                                              diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 59dc74d..0c1d75a 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                              aws4embeddedlinux-cdk-lib
                                                                Preparing search index...

                                                                Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                For configuration options see BuildBaseImageCodePipelineProps.

                                                                -

                                                                Hierarchy

                                                                • Stack
                                                                  • EmbeddedLinuxCodePipelineBaseImageStack
                                                                Index

                                                                Constructors

                                                                constructor +

                                                                Hierarchy

                                                                • Stack
                                                                  • EmbeddedLinuxCodePipelineBaseImageStack
                                                                Index

                                                                Constructors

                                                                constructor

                                                                Properties

                                                                tags templateOptions region @@ -53,7 +53,7 @@ _toCloudFormation isConstruct toString -

                                                                Constructors

                                                                Properties

                                                                tags: TagManager

                                                                Tags to be applied to the stack.

                                                                +

                                                                Constructors

                                                                Properties

                                                                tags: TagManager

                                                                Tags to be applied to the stack.

                                                                templateOptions: ITemplateOptions

                                                                Options for CloudFormation template (like version, transform, description).

                                                                region: string

                                                                The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                This value is resolved according to the following rules:

                                                                @@ -110,8 +110,8 @@

                                                                Readonly Internal_crossRegionReferences

                                                                _crossRegionReferences: boolean

                                                                Whether cross region references are enabled for this stack

                                                                Optional Readonly Internal_notificationArns

                                                                _notificationArns?: string[]

                                                                SNS Notification ARNs to receive stack events.

                                                                ecrRepository: IRepository

                                                                The ECR Repository where the image is located.

                                                                -
                                                                ecrRepositoryImageTag: string

                                                                The ECR Image Tag to find the base imaged.

                                                                -
                                                                node: Node

                                                                The tree node.

                                                                +
                                                                ecrRepositoryImageTag: string

                                                                The ECR Image Tag to find the base imaged.

                                                                +
                                                                node: Node

                                                                The tree node.

                                                                Accessors

                                                                • get terminationProtection(): boolean

                                                                  Whether termination protection is enabled for this stack.

                                                                  Returns boolean

                                                                • set terminationProtection(value: boolean): void

                                                                  Parameters

                                                                  • value: boolean

                                                                  Returns void

                                                                • get dependencies(): Stack[]

                                                                  Return the stacks this stack depends on

                                                                  Returns Stack[]

                                                                ecrRepository: IRepository

                                                                ECR Repository where the Build Host Image resides.

                                                                -
                                                                ecrRepositoryImageTag: string

                                                                Tag for the Build Host Image

                                                                -
                                                                vpc: IVpc

                                                                VPC where the networking setup resides.

                                                                -
                                                                buildPolicyAdditions?: PolicyStatement[]

                                                                Additional policy statements to add to the build project.

                                                                -
                                                                encryptionKey: Key

                                                                The encryption key use across

                                                                -

                                                                Settings

                                                                Member Visibility

                                                                On This Page

                                                                Properties
                                                                +
                                                                ecrRepositoryImageTag: string

                                                                Tag for the Build Host Image

                                                                +
                                                                vpc: IVpc

                                                                VPC where the networking setup resides.

                                                                +
                                                                buildPolicyAdditions?: PolicyStatement[]

                                                                Additional policy statements to add to the build project.

                                                                +
                                                                encryptionKey: Key

                                                                The encryption key use across

                                                                +

                                                                Settings

                                                                Member Visibility

                                                                On This Page

                                                                Properties
                                                                diff --git a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html index da913fc..d4d33a6 100644 --- a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineBaseImageProps | aws4embeddedlinux-cdk-lib
                                                                aws4embeddedlinux-cdk-lib
                                                                  Preparing search index...

                                                                  Interface EmbeddedLinuxCodePipelineBaseImageProps

                                                                  Select options for the BuildImageCodePipelineStack.

                                                                  -
                                                                  interface EmbeddedLinuxCodePipelineBaseImageProps {
                                                                      description?: string;
                                                                      env?: Environment;
                                                                      stackName?: string;
                                                                      tags?: { [key: string]: string };
                                                                      notificationArns?: string[];
                                                                      synthesizer?: IStackSynthesizer;
                                                                      terminationProtection?: boolean;
                                                                      analyticsReporting?: boolean;
                                                                      crossRegionReferences?: boolean;
                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                      suppressTemplateIndentation?: boolean;
                                                                      pipelineSourceBucket: IBucket;
                                                                      pipelineSourcePrefix?: string;
                                                                      pipelineArtifactBucket: Bucket;
                                                                      ecrRepository: IRepository;
                                                                      encryptionKey: Key;
                                                                  }

                                                                  Hierarchy

                                                                  • StackProps
                                                                    • EmbeddedLinuxCodePipelineBaseImageProps
                                                                  Index

                                                                  Properties

                                                                  description? +
                                                                  interface EmbeddedLinuxCodePipelineBaseImageProps {
                                                                      description?: string;
                                                                      env?: Environment;
                                                                      stackName?: string;
                                                                      tags?: { [key: string]: string };
                                                                      notificationArns?: string[];
                                                                      synthesizer?: IStackSynthesizer;
                                                                      terminationProtection?: boolean;
                                                                      analyticsReporting?: boolean;
                                                                      crossRegionReferences?: boolean;
                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                      suppressTemplateIndentation?: boolean;
                                                                      pipelineSourceBucket: IBucket;
                                                                      pipelineSourcePrefix?: string;
                                                                      pipelineArtifactBucket: Bucket;
                                                                      ecrRepository: IRepository;
                                                                      encryptionKey: Key;
                                                                  }

                                                                  Hierarchy

                                                                  • StackProps
                                                                    • EmbeddedLinuxCodePipelineBaseImageProps
                                                                  Index

                                                                  Properties

                                                                  description? env? stackName? tags? @@ -95,8 +95,8 @@
                                                                • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                                                  • pipelineSourceBucket: IBucket

                                                                  The pipeline source bucket

                                                                  -
                                                                  pipelineSourcePrefix?: string

                                                                  The pipeline source prefix

                                                                  -
                                                                  pipelineArtifactBucket: Bucket

                                                                  Artifact bucket to use

                                                                  -
                                                                  ecrRepository: IRepository

                                                                  The ECR Repository to push to.

                                                                  -
                                                                  encryptionKey: Key

                                                                  The encryption key use across

                                                                  -

                                                                  Settings

                                                                  Member Visibility

                                                                  On This Page

                                                                  Properties
                                                                  +
                                                                  pipelineSourcePrefix?: string

                                                                  The pipeline source prefix

                                                                  +
                                                                  pipelineArtifactBucket: Bucket

                                                                  Artifact bucket to use

                                                                  +
                                                                  ecrRepository: IRepository

                                                                  The ECR Repository to push to.

                                                                  +
                                                                  encryptionKey: Key

                                                                  The encryption key use across

                                                                  +

                                                                  Settings

                                                                  Member Visibility

                                                                  On This Page

                                                                  Properties
                                                                  diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index fea3521..26e1f4d 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                  aws4embeddedlinux-cdk-lib
                                                                    Preparing search index...

                                                                    Interface EmbeddedLinuxCodePipelineProps

                                                                    Properties to allow customizing the build.

                                                                    -
                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                        description?: string;
                                                                        env?: Environment;
                                                                        stackName?: string;
                                                                        tags?: { [key: string]: string };
                                                                        notificationArns?: string[];
                                                                        synthesizer?: IStackSynthesizer;
                                                                        terminationProtection?: boolean;
                                                                        analyticsReporting?: boolean;
                                                                        crossRegionReferences?: boolean;
                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                        suppressTemplateIndentation?: boolean;
                                                                        pipelineSourceBucket: IBucket;
                                                                        pipelineSourcePrefix?: string;
                                                                        pipelineArtifactBucket: Bucket;
                                                                        pipelineArtifactPrefix?: string;
                                                                        pipelineOutputBucket: Bucket;
                                                                        pipelineOutputPrefix?: string;
                                                                        ecrRepository: IRepository;
                                                                        ecrRepositoryImageTag: string;
                                                                        projectType: ProjectType;
                                                                        vpc: IVpc;
                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                        encryptionKey: Key;
                                                                        sourceCustomPath?: string;
                                                                    }

                                                                    Hierarchy

                                                                    • StackProps
                                                                      • EmbeddedLinuxCodePipelineProps
                                                                    Index

                                                                    Properties

                                                                    description? +
                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                        description?: string;
                                                                        env?: Environment;
                                                                        stackName?: string;
                                                                        tags?: { [key: string]: string };
                                                                        notificationArns?: string[];
                                                                        synthesizer?: IStackSynthesizer;
                                                                        terminationProtection?: boolean;
                                                                        analyticsReporting?: boolean;
                                                                        crossRegionReferences?: boolean;
                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                        suppressTemplateIndentation?: boolean;
                                                                        pipelineSourceBucket: IBucket;
                                                                        pipelineSourcePrefix?: string;
                                                                        pipelineArtifactBucket: Bucket;
                                                                        pipelineArtifactPrefix?: string;
                                                                        pipelineOutputBucket: Bucket;
                                                                        pipelineOutputPrefix?: string;
                                                                        ecrRepository: IRepository;
                                                                        ecrRepositoryImageTag: string;
                                                                        projectType: ProjectType;
                                                                        vpc: IVpc;
                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                        encryptionKey: Key;
                                                                        sourceCustomPath?: string;
                                                                    }

                                                                    Hierarchy

                                                                    • StackProps
                                                                      • EmbeddedLinuxCodePipelineProps
                                                                    Index

                                                                    Properties

                                                                    description? env? stackName? tags? @@ -104,17 +104,17 @@
                                                                  • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                                                    • pipelineSourceBucket: IBucket

                                                                    The pipeline source bucket

                                                                    -
                                                                    pipelineSourcePrefix?: string

                                                                    The pipeline source prefix

                                                                    -
                                                                    pipelineArtifactBucket: Bucket

                                                                    The pipeline artifact bucket to use

                                                                    -
                                                                    pipelineArtifactPrefix?: string

                                                                    The pipeline artifact bucket prefix to use

                                                                    -
                                                                    pipelineOutputBucket: Bucket

                                                                    The pipeline output bucket to use

                                                                    -
                                                                    pipelineOutputPrefix?: string

                                                                    The pipeline output bucket prefix to use

                                                                    -
                                                                    ecrRepository: IRepository

                                                                    ECR Repository where the Build Host Image resides.

                                                                    -
                                                                    ecrRepositoryImageTag: string

                                                                    Tag for the Build Host Image

                                                                    -
                                                                    projectType: ProjectType

                                                                    The type of project being built.

                                                                    -
                                                                    vpc: IVpc

                                                                    VPC where the networking setup resides.

                                                                    -
                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                    Additional policy statements to add to the build project.

                                                                    -
                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                    Additional build environment variables to the build project.

                                                                    -
                                                                    encryptionKey: Key

                                                                    The encryption key use across

                                                                    -
                                                                    sourceCustomPath?: string

                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                    -

                                                                    Settings

                                                                    Member Visibility

                                                                    On This Page

                                                                    Properties
                                                                    +
                                                                    pipelineSourcePrefix?: string

                                                                    The pipeline source prefix

                                                                    +
                                                                    pipelineArtifactBucket: Bucket

                                                                    The pipeline artifact bucket to use

                                                                    +
                                                                    pipelineArtifactPrefix?: string

                                                                    The pipeline artifact bucket prefix to use

                                                                    +
                                                                    pipelineOutputBucket: Bucket

                                                                    The pipeline output bucket to use

                                                                    +
                                                                    pipelineOutputPrefix?: string

                                                                    The pipeline output bucket prefix to use

                                                                    +
                                                                    ecrRepository: IRepository

                                                                    ECR Repository where the Build Host Image resides.

                                                                    +
                                                                    ecrRepositoryImageTag: string

                                                                    Tag for the Build Host Image

                                                                    +
                                                                    projectType: ProjectType

                                                                    The type of project being built.

                                                                    +
                                                                    vpc: IVpc

                                                                    VPC where the networking setup resides.

                                                                    +
                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                    Additional policy statements to add to the build project.

                                                                    +
                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                    Additional build environment variables to the build project.

                                                                    +
                                                                    encryptionKey: Key

                                                                    The encryption key use across

                                                                    +
                                                                    sourceCustomPath?: string

                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                    +

                                                                    Settings

                                                                    Member Visibility

                                                                    On This Page

                                                                    Properties
                                                                    diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index cd8b48d..2b46e4c 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                    aws4embeddedlinux-cdk-lib
                                                                      Preparing search index...

                                                                      Interface PipelineResourcesProps

                                                                      Select options for the PipelineResourcesStack.

                                                                      -
                                                                      interface PipelineResourcesProps {
                                                                          description?: string;
                                                                          env?: Environment;
                                                                          stackName?: string;
                                                                          tags?: { [key: string]: string };
                                                                          notificationArns?: string[];
                                                                          synthesizer?: IStackSynthesizer;
                                                                          terminationProtection?: boolean;
                                                                          analyticsReporting?: boolean;
                                                                          crossRegionReferences?: boolean;
                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                          suppressTemplateIndentation?: boolean;
                                                                          resource_prefix: string;
                                                                          ecrRepositoryName?: string;
                                                                          pipelineArtifactBucketName?: string;
                                                                          pipelineSourceBucketName?: string;
                                                                          pipelineOutputBucketName?: string;
                                                                          loggingBucketName?: string;
                                                                      }

                                                                      Hierarchy

                                                                      • StackProps
                                                                        • PipelineResourcesProps
                                                                      Index

                                                                      Properties

                                                                      description? +
                                                                      interface PipelineResourcesProps {
                                                                          description?: string;
                                                                          env?: Environment;
                                                                          stackName?: string;
                                                                          tags?: { [key: string]: string };
                                                                          notificationArns?: string[];
                                                                          synthesizer?: IStackSynthesizer;
                                                                          terminationProtection?: boolean;
                                                                          analyticsReporting?: boolean;
                                                                          crossRegionReferences?: boolean;
                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                          suppressTemplateIndentation?: boolean;
                                                                          resource_prefix: string;
                                                                          ecrRepositoryName?: string;
                                                                          pipelineArtifactBucketName?: string;
                                                                          pipelineSourceBucketName?: string;
                                                                          pipelineOutputBucketName?: string;
                                                                          loggingBucketName?: string;
                                                                      }

                                                                      Hierarchy

                                                                      • StackProps
                                                                        • PipelineResourcesProps
                                                                      Index

                                                                      Properties

                                                                      description? env? stackName? tags? @@ -96,9 +96,9 @@
                                                                    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                                                      • resource_prefix: string

                                                                      The resource prefix

                                                                      -
                                                                      ecrRepositoryName?: string

                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                      -
                                                                      pipelineArtifactBucketName?: string

                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                      -
                                                                      pipelineSourceBucketName?: string

                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                      -
                                                                      pipelineOutputBucketName?: string

                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                      -
                                                                      loggingBucketName?: string

                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                      -

                                                                      Settings

                                                                      Member Visibility

                                                                      On This Page

                                                                      Properties
                                                                      +
                                                                      ecrRepositoryName?: string

                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                      +
                                                                      pipelineArtifactBucketName?: string

                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                      +
                                                                      pipelineSourceBucketName?: string

                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                      +
                                                                      pipelineOutputBucketName?: string

                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                      +
                                                                      loggingBucketName?: string

                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                      +

                                                                      Settings

                                                                      Member Visibility

                                                                      On This Page

                                                                      Properties
                                                                      From 1d8c9e98d7e46007fa1ae13f6ecc4571b8c4211b Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 15 Jul 2025 05:35:04 +0000 Subject: [PATCH 34/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@3e02ef6217abfd58f5a26fc5d7?= =?UTF-8?q?27ebe83aea8ffd=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index e9c19c0..90bda75 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                      aws4embeddedlinux-cdk-lib
                                                                        Preparing search index...

                                                                        Class EmbeddedLinuxCodeBuildProjectStack

                                                                        The stack for creating a build pipeline.

                                                                        See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                        -

                                                                        Hierarchy

                                                                        • Stack
                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                        Index

                                                                        Constructors

                                                                        constructor +

                                                                        Hierarchy

                                                                        • Stack
                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                        Index

                                                                        Constructors

                                                                        constructor

                                                                        Properties

                                                                        tags templateOptions region @@ -50,7 +50,7 @@ _toCloudFormation isConstruct toString -

                                                                        Constructors

                                                                        Properties

                                                                        tags: TagManager

                                                                        Tags to be applied to the stack.

                                                                        +

                                                                        Constructors

                                                                        Properties

                                                                        tags: TagManager

                                                                        Tags to be applied to the stack.

                                                                        templateOptions: ITemplateOptions

                                                                        Options for CloudFormation template (like version, transform, description).

                                                                        region: string

                                                                        The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                        This value is resolved according to the following rules:

                                                                        diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 0c1d75a..5b3d0c2 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                        aws4embeddedlinux-cdk-lib
                                                                          Preparing search index...

                                                                          Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                          The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                          For configuration options see BuildBaseImageCodePipelineProps.

                                                                          -

                                                                          Hierarchy

                                                                          • Stack
                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                          Index

                                                                          Constructors

                                                                          constructor +

                                                                          Hierarchy

                                                                          • Stack
                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                          Index

                                                                          Constructors

                                                                          constructor

                                                                          Properties

                                                                          tags templateOptions region @@ -53,7 +53,7 @@ _toCloudFormation isConstruct toString -

                                                                          Constructors

                                                                          Properties

                                                                          tags: TagManager

                                                                          Tags to be applied to the stack.

                                                                          +

                                                                          Constructors

                                                                          Properties

                                                                          tags: TagManager

                                                                          Tags to be applied to the stack.

                                                                          templateOptions: ITemplateOptions

                                                                          Options for CloudFormation template (like version, transform, description).

                                                                          region: string

                                                                          The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                          This value is resolved according to the following rules:

                                                                          @@ -110,8 +110,8 @@

                                                                          Readonly Internal_crossRegionReferences

                                                                          _crossRegionReferences: boolean

                                                                          Whether cross region references are enabled for this stack

                                                                          Optional Readonly Internal_notificationArns

                                                                          _notificationArns?: string[]

                                                                          SNS Notification ARNs to receive stack events.

                                                                          ecrRepository: IRepository

                                                                          The ECR Repository where the image is located.

                                                                          -
                                                                          ecrRepositoryImageTag: string

                                                                          The ECR Image Tag to find the base imaged.

                                                                          -
                                                                          node: Node

                                                                          The tree node.

                                                                          +
                                                                          ecrRepositoryImageTag: string

                                                                          The ECR Image Tag to find the base imaged.

                                                                          +
                                                                          node: Node

                                                                          The tree node.

                                                                          Accessors

                                                                          • get terminationProtection(): boolean

                                                                            Whether termination protection is enabled for this stack.

                                                                            Returns boolean

                                                                          • set terminationProtection(value: boolean): void

                                                                            Parameters

                                                                            • value: boolean

                                                                            Returns void

                                                                          • get dependencies(): Stack[]

                                                                            Return the stacks this stack depends on

                                                                            Returns Stack[]

                                                                          ecrRepository: IRepository

                                                                          ECR Repository where the Build Host Image resides.

                                                                          -
                                                                          ecrRepositoryImageTag: string

                                                                          Tag for the Build Host Image

                                                                          -
                                                                          vpc: IVpc

                                                                          VPC where the networking setup resides.

                                                                          -
                                                                          buildPolicyAdditions?: PolicyStatement[]

                                                                          Additional policy statements to add to the build project.

                                                                          -
                                                                          encryptionKey: Key

                                                                          The encryption key use across

                                                                          -

                                                                          Settings

                                                                          Member Visibility

                                                                          On This Page

                                                                          Properties
                                                                          +
                                                                          ecrRepositoryImageTag: string

                                                                          Tag for the Build Host Image

                                                                          +
                                                                          vpc: IVpc

                                                                          VPC where the networking setup resides.

                                                                          +
                                                                          buildPolicyAdditions?: PolicyStatement[]

                                                                          Additional policy statements to add to the build project.

                                                                          +
                                                                          encryptionKey: Key

                                                                          The encryption key use across

                                                                          +

                                                                          Settings

                                                                          Member Visibility

                                                                          On This Page

                                                                          Properties
                                                                          diff --git a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html index d4d33a6..105ead8 100644 --- a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineBaseImageProps | aws4embeddedlinux-cdk-lib
                                                                          aws4embeddedlinux-cdk-lib
                                                                            Preparing search index...

                                                                            Interface EmbeddedLinuxCodePipelineBaseImageProps

                                                                            Select options for the BuildImageCodePipelineStack.

                                                                            -
                                                                            interface EmbeddedLinuxCodePipelineBaseImageProps {
                                                                                description?: string;
                                                                                env?: Environment;
                                                                                stackName?: string;
                                                                                tags?: { [key: string]: string };
                                                                                notificationArns?: string[];
                                                                                synthesizer?: IStackSynthesizer;
                                                                                terminationProtection?: boolean;
                                                                                analyticsReporting?: boolean;
                                                                                crossRegionReferences?: boolean;
                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                suppressTemplateIndentation?: boolean;
                                                                                pipelineSourceBucket: IBucket;
                                                                                pipelineSourcePrefix?: string;
                                                                                pipelineArtifactBucket: Bucket;
                                                                                ecrRepository: IRepository;
                                                                                encryptionKey: Key;
                                                                            }

                                                                            Hierarchy

                                                                            • StackProps
                                                                              • EmbeddedLinuxCodePipelineBaseImageProps
                                                                            Index

                                                                            Properties

                                                                            description? +
                                                                            interface EmbeddedLinuxCodePipelineBaseImageProps {
                                                                                description?: string;
                                                                                env?: Environment;
                                                                                stackName?: string;
                                                                                tags?: { [key: string]: string };
                                                                                notificationArns?: string[];
                                                                                synthesizer?: IStackSynthesizer;
                                                                                terminationProtection?: boolean;
                                                                                analyticsReporting?: boolean;
                                                                                crossRegionReferences?: boolean;
                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                suppressTemplateIndentation?: boolean;
                                                                                pipelineSourceBucket: IBucket;
                                                                                pipelineSourcePrefix?: string;
                                                                                pipelineArtifactBucket: Bucket;
                                                                                ecrRepository: IRepository;
                                                                                encryptionKey: Key;
                                                                            }

                                                                            Hierarchy

                                                                            • StackProps
                                                                              • EmbeddedLinuxCodePipelineBaseImageProps
                                                                            Index

                                                                            Properties

                                                                            description? env? stackName? tags? @@ -95,8 +95,8 @@
                                                                          • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                                                            • pipelineSourceBucket: IBucket

                                                                            The pipeline source bucket

                                                                            -
                                                                            pipelineSourcePrefix?: string

                                                                            The pipeline source prefix

                                                                            -
                                                                            pipelineArtifactBucket: Bucket

                                                                            Artifact bucket to use

                                                                            -
                                                                            ecrRepository: IRepository

                                                                            The ECR Repository to push to.

                                                                            -
                                                                            encryptionKey: Key

                                                                            The encryption key use across

                                                                            -

                                                                            Settings

                                                                            Member Visibility

                                                                            On This Page

                                                                            Properties
                                                                            +
                                                                            pipelineSourcePrefix?: string

                                                                            The pipeline source prefix

                                                                            +
                                                                            pipelineArtifactBucket: Bucket

                                                                            Artifact bucket to use

                                                                            +
                                                                            ecrRepository: IRepository

                                                                            The ECR Repository to push to.

                                                                            +
                                                                            encryptionKey: Key

                                                                            The encryption key use across

                                                                            +

                                                                            Settings

                                                                            Member Visibility

                                                                            On This Page

                                                                            Properties
                                                                            diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 26e1f4d..1d5a077 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                            aws4embeddedlinux-cdk-lib
                                                                              Preparing search index...

                                                                              Interface EmbeddedLinuxCodePipelineProps

                                                                              Properties to allow customizing the build.

                                                                              -
                                                                              interface EmbeddedLinuxCodePipelineProps {
                                                                                  description?: string;
                                                                                  env?: Environment;
                                                                                  stackName?: string;
                                                                                  tags?: { [key: string]: string };
                                                                                  notificationArns?: string[];
                                                                                  synthesizer?: IStackSynthesizer;
                                                                                  terminationProtection?: boolean;
                                                                                  analyticsReporting?: boolean;
                                                                                  crossRegionReferences?: boolean;
                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                  suppressTemplateIndentation?: boolean;
                                                                                  pipelineSourceBucket: IBucket;
                                                                                  pipelineSourcePrefix?: string;
                                                                                  pipelineArtifactBucket: Bucket;
                                                                                  pipelineArtifactPrefix?: string;
                                                                                  pipelineOutputBucket: Bucket;
                                                                                  pipelineOutputPrefix?: string;
                                                                                  ecrRepository: IRepository;
                                                                                  ecrRepositoryImageTag: string;
                                                                                  projectType: ProjectType;
                                                                                  vpc: IVpc;
                                                                                  buildPolicyAdditions?: PolicyStatement[];
                                                                                  environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                  encryptionKey: Key;
                                                                                  sourceCustomPath?: string;
                                                                              }

                                                                              Hierarchy

                                                                              • StackProps
                                                                                • EmbeddedLinuxCodePipelineProps
                                                                              Index

                                                                              Properties

                                                                              description? +
                                                                              interface EmbeddedLinuxCodePipelineProps {
                                                                                  description?: string;
                                                                                  env?: Environment;
                                                                                  stackName?: string;
                                                                                  tags?: { [key: string]: string };
                                                                                  notificationArns?: string[];
                                                                                  synthesizer?: IStackSynthesizer;
                                                                                  terminationProtection?: boolean;
                                                                                  analyticsReporting?: boolean;
                                                                                  crossRegionReferences?: boolean;
                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                  suppressTemplateIndentation?: boolean;
                                                                                  pipelineSourceBucket: IBucket;
                                                                                  pipelineSourcePrefix?: string;
                                                                                  pipelineArtifactBucket: Bucket;
                                                                                  pipelineArtifactPrefix?: string;
                                                                                  pipelineOutputBucket: Bucket;
                                                                                  pipelineOutputPrefix?: string;
                                                                                  ecrRepository: IRepository;
                                                                                  ecrRepositoryImageTag: string;
                                                                                  projectType: ProjectType;
                                                                                  vpc: IVpc;
                                                                                  buildPolicyAdditions?: PolicyStatement[];
                                                                                  environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                  encryptionKey: Key;
                                                                                  sourceCustomPath?: string;
                                                                              }

                                                                              Hierarchy

                                                                              • StackProps
                                                                                • EmbeddedLinuxCodePipelineProps
                                                                              Index

                                                                              Properties

                                                                              description? env? stackName? tags? @@ -104,17 +104,17 @@
                                                                            • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                                                              • pipelineSourceBucket: IBucket

                                                                              The pipeline source bucket

                                                                              -
                                                                              pipelineSourcePrefix?: string

                                                                              The pipeline source prefix

                                                                              -
                                                                              pipelineArtifactBucket: Bucket

                                                                              The pipeline artifact bucket to use

                                                                              -
                                                                              pipelineArtifactPrefix?: string

                                                                              The pipeline artifact bucket prefix to use

                                                                              -
                                                                              pipelineOutputBucket: Bucket

                                                                              The pipeline output bucket to use

                                                                              -
                                                                              pipelineOutputPrefix?: string

                                                                              The pipeline output bucket prefix to use

                                                                              -
                                                                              ecrRepository: IRepository

                                                                              ECR Repository where the Build Host Image resides.

                                                                              -
                                                                              ecrRepositoryImageTag: string

                                                                              Tag for the Build Host Image

                                                                              -
                                                                              projectType: ProjectType

                                                                              The type of project being built.

                                                                              -
                                                                              vpc: IVpc

                                                                              VPC where the networking setup resides.

                                                                              -
                                                                              buildPolicyAdditions?: PolicyStatement[]

                                                                              Additional policy statements to add to the build project.

                                                                              -
                                                                              environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                              Additional build environment variables to the build project.

                                                                              -
                                                                              encryptionKey: Key

                                                                              The encryption key use across

                                                                              -
                                                                              sourceCustomPath?: string

                                                                              Custom asset to be provided when using ProjectType.Custom

                                                                              -

                                                                              Settings

                                                                              Member Visibility

                                                                              On This Page

                                                                              Properties
                                                                              +
                                                                              pipelineSourcePrefix?: string

                                                                              The pipeline source prefix

                                                                              +
                                                                              pipelineArtifactBucket: Bucket

                                                                              The pipeline artifact bucket to use

                                                                              +
                                                                              pipelineArtifactPrefix?: string

                                                                              The pipeline artifact bucket prefix to use

                                                                              +
                                                                              pipelineOutputBucket: Bucket

                                                                              The pipeline output bucket to use

                                                                              +
                                                                              pipelineOutputPrefix?: string

                                                                              The pipeline output bucket prefix to use

                                                                              +
                                                                              ecrRepository: IRepository

                                                                              ECR Repository where the Build Host Image resides.

                                                                              +
                                                                              ecrRepositoryImageTag: string

                                                                              Tag for the Build Host Image

                                                                              +
                                                                              projectType: ProjectType

                                                                              The type of project being built.

                                                                              +
                                                                              vpc: IVpc

                                                                              VPC where the networking setup resides.

                                                                              +
                                                                              buildPolicyAdditions?: PolicyStatement[]

                                                                              Additional policy statements to add to the build project.

                                                                              +
                                                                              environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                              Additional build environment variables to the build project.

                                                                              +
                                                                              encryptionKey: Key

                                                                              The encryption key use across

                                                                              +
                                                                              sourceCustomPath?: string

                                                                              Custom asset to be provided when using ProjectType.Custom

                                                                              +

                                                                              Settings

                                                                              Member Visibility

                                                                              On This Page

                                                                              Properties
                                                                              diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 2b46e4c..a8441cc 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                              aws4embeddedlinux-cdk-lib
                                                                                Preparing search index...

                                                                                Interface PipelineResourcesProps

                                                                                Select options for the PipelineResourcesStack.

                                                                                -
                                                                                interface PipelineResourcesProps {
                                                                                    description?: string;
                                                                                    env?: Environment;
                                                                                    stackName?: string;
                                                                                    tags?: { [key: string]: string };
                                                                                    notificationArns?: string[];
                                                                                    synthesizer?: IStackSynthesizer;
                                                                                    terminationProtection?: boolean;
                                                                                    analyticsReporting?: boolean;
                                                                                    crossRegionReferences?: boolean;
                                                                                    permissionsBoundary?: PermissionsBoundary;
                                                                                    suppressTemplateIndentation?: boolean;
                                                                                    resource_prefix: string;
                                                                                    ecrRepositoryName?: string;
                                                                                    pipelineArtifactBucketName?: string;
                                                                                    pipelineSourceBucketName?: string;
                                                                                    pipelineOutputBucketName?: string;
                                                                                    loggingBucketName?: string;
                                                                                }

                                                                                Hierarchy

                                                                                • StackProps
                                                                                  • PipelineResourcesProps
                                                                                Index

                                                                                Properties

                                                                                description? +
                                                                                interface PipelineResourcesProps {
                                                                                    description?: string;
                                                                                    env?: Environment;
                                                                                    stackName?: string;
                                                                                    tags?: { [key: string]: string };
                                                                                    notificationArns?: string[];
                                                                                    synthesizer?: IStackSynthesizer;
                                                                                    terminationProtection?: boolean;
                                                                                    analyticsReporting?: boolean;
                                                                                    crossRegionReferences?: boolean;
                                                                                    permissionsBoundary?: PermissionsBoundary;
                                                                                    suppressTemplateIndentation?: boolean;
                                                                                    resource_prefix: string;
                                                                                    ecrRepositoryName?: string;
                                                                                    pipelineArtifactBucketName?: string;
                                                                                    pipelineSourceBucketName?: string;
                                                                                    pipelineOutputBucketName?: string;
                                                                                    loggingBucketName?: string;
                                                                                }

                                                                                Hierarchy

                                                                                • StackProps
                                                                                  • PipelineResourcesProps
                                                                                Index

                                                                                Properties

                                                                                description? env? stackName? tags? @@ -96,9 +96,9 @@
                                                                              • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                                                                • resource_prefix: string

                                                                                The resource prefix

                                                                                -
                                                                                ecrRepositoryName?: string

                                                                                The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                -
                                                                                pipelineArtifactBucketName?: string

                                                                                The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                -
                                                                                pipelineSourceBucketName?: string

                                                                                The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                -
                                                                                pipelineOutputBucketName?: string

                                                                                The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                -
                                                                                loggingBucketName?: string

                                                                                Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                -

                                                                                Settings

                                                                                Member Visibility

                                                                                On This Page

                                                                                Properties
                                                                                +
                                                                                ecrRepositoryName?: string

                                                                                The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                +
                                                                                pipelineArtifactBucketName?: string

                                                                                The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                +
                                                                                pipelineSourceBucketName?: string

                                                                                The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                +
                                                                                pipelineOutputBucketName?: string

                                                                                The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                +
                                                                                loggingBucketName?: string

                                                                                Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                +

                                                                                Settings

                                                                                Member Visibility

                                                                                On This Page

                                                                                Properties
                                                                                From 9d538db17369372ae28f12a503aae534acb87d92 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 15 Jul 2025 05:35:18 +0000 Subject: [PATCH 35/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@ca420f00cf695595024caacdae?= =?UTF-8?q?14881d2527964d=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 90bda75..538805a 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                aws4embeddedlinux-cdk-lib
                                                                                  Preparing search index...

                                                                                  Class EmbeddedLinuxCodeBuildProjectStack

                                                                                  The stack for creating a build pipeline.

                                                                                  See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                  -

                                                                                  Hierarchy

                                                                                  • Stack
                                                                                    • EmbeddedLinuxCodeBuildProjectStack
                                                                                  Index

                                                                                  Constructors

                                                                                  constructor +

                                                                                  Hierarchy

                                                                                  • Stack
                                                                                    • EmbeddedLinuxCodeBuildProjectStack
                                                                                  Index

                                                                                  Constructors

                                                                                  constructor

                                                                                  Properties

                                                                                  tags templateOptions region @@ -50,7 +50,7 @@ _toCloudFormation isConstruct toString -

                                                                                  Constructors

                                                                                  Properties

                                                                                  tags: TagManager

                                                                                  Tags to be applied to the stack.

                                                                                  +

                                                                                  Constructors

                                                                                  Properties

                                                                                  tags: TagManager

                                                                                  Tags to be applied to the stack.

                                                                                  templateOptions: ITemplateOptions

                                                                                  Options for CloudFormation template (like version, transform, description).

                                                                                  region: string

                                                                                  The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                  This value is resolved according to the following rules:

                                                                                  diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 5b3d0c2..eb356b5 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                  aws4embeddedlinux-cdk-lib
                                                                                    Preparing search index...

                                                                                    Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                    The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                    For configuration options see BuildBaseImageCodePipelineProps.

                                                                                    -

                                                                                    Hierarchy

                                                                                    • Stack
                                                                                      • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                    Index

                                                                                    Constructors

                                                                                    constructor +

                                                                                    Hierarchy

                                                                                    • Stack
                                                                                      • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                    Index

                                                                                    Constructors

                                                                                    constructor

                                                                                    Properties

                                                                                    tags templateOptions region @@ -53,7 +53,7 @@ _toCloudFormation isConstruct toString -

                                                                                    Constructors

                                                                                    Properties

                                                                                    tags: TagManager

                                                                                    Tags to be applied to the stack.

                                                                                    +

                                                                                    Constructors

                                                                                    Properties

                                                                                    tags: TagManager

                                                                                    Tags to be applied to the stack.

                                                                                    templateOptions: ITemplateOptions

                                                                                    Options for CloudFormation template (like version, transform, description).

                                                                                    region: string

                                                                                    The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                    This value is resolved according to the following rules:

                                                                                    @@ -110,8 +110,8 @@

                                                                                    Readonly Internal_crossRegionReferences

                                                                                    _crossRegionReferences: boolean

                                                                                    Whether cross region references are enabled for this stack

                                                                                    Optional Readonly Internal_notificationArns

                                                                                    _notificationArns?: string[]

                                                                                    SNS Notification ARNs to receive stack events.

                                                                                    ecrRepository: IRepository

                                                                                    The ECR Repository where the image is located.

                                                                                    -
                                                                                    ecrRepositoryImageTag: string

                                                                                    The ECR Image Tag to find the base imaged.

                                                                                    -
                                                                                    node: Node

                                                                                    The tree node.

                                                                                    +
                                                                                    ecrRepositoryImageTag: string

                                                                                    The ECR Image Tag to find the base imaged.

                                                                                    +
                                                                                    node: Node

                                                                                    The tree node.

                                                                                    Accessors

                                                                                    • get terminationProtection(): boolean

                                                                                      Whether termination protection is enabled for this stack.

                                                                                      Returns boolean

                                                                                    • set terminationProtection(value: boolean): void

                                                                                      Parameters

                                                                                      • value: boolean

                                                                                      Returns void

                                                                                    • get dependencies(): Stack[]

                                                                                      Return the stacks this stack depends on

                                                                                      Returns Stack[]

                                                                                    ecrRepository: IRepository

                                                                                    ECR Repository where the Build Host Image resides.

                                                                                    -
                                                                                    ecrRepositoryImageTag: string

                                                                                    Tag for the Build Host Image

                                                                                    -
                                                                                    vpc: IVpc

                                                                                    VPC where the networking setup resides.

                                                                                    -
                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                    Additional policy statements to add to the build project.

                                                                                    -
                                                                                    encryptionKey: Key

                                                                                    The encryption key use across

                                                                                    -

                                                                                    Settings

                                                                                    Member Visibility

                                                                                    On This Page

                                                                                    Properties
                                                                                    +
                                                                                    ecrRepositoryImageTag: string

                                                                                    Tag for the Build Host Image

                                                                                    +
                                                                                    vpc: IVpc

                                                                                    VPC where the networking setup resides.

                                                                                    +
                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                    Additional policy statements to add to the build project.

                                                                                    +
                                                                                    encryptionKey: Key

                                                                                    The encryption key use across

                                                                                    +

                                                                                    Settings

                                                                                    Member Visibility

                                                                                    On This Page

                                                                                    Properties
                                                                                    diff --git a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html index 105ead8..ff5f9bf 100644 --- a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineBaseImageProps | aws4embeddedlinux-cdk-lib
                                                                                    aws4embeddedlinux-cdk-lib
                                                                                      Preparing search index...

                                                                                      Interface EmbeddedLinuxCodePipelineBaseImageProps

                                                                                      Select options for the BuildImageCodePipelineStack.

                                                                                      -
                                                                                      interface EmbeddedLinuxCodePipelineBaseImageProps {
                                                                                          description?: string;
                                                                                          env?: Environment;
                                                                                          stackName?: string;
                                                                                          tags?: { [key: string]: string };
                                                                                          notificationArns?: string[];
                                                                                          synthesizer?: IStackSynthesizer;
                                                                                          terminationProtection?: boolean;
                                                                                          analyticsReporting?: boolean;
                                                                                          crossRegionReferences?: boolean;
                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                          suppressTemplateIndentation?: boolean;
                                                                                          pipelineSourceBucket: IBucket;
                                                                                          pipelineSourcePrefix?: string;
                                                                                          pipelineArtifactBucket: Bucket;
                                                                                          ecrRepository: IRepository;
                                                                                          encryptionKey: Key;
                                                                                      }

                                                                                      Hierarchy

                                                                                      • StackProps
                                                                                        • EmbeddedLinuxCodePipelineBaseImageProps
                                                                                      Index

                                                                                      Properties

                                                                                      description? +
                                                                                      interface EmbeddedLinuxCodePipelineBaseImageProps {
                                                                                          description?: string;
                                                                                          env?: Environment;
                                                                                          stackName?: string;
                                                                                          tags?: { [key: string]: string };
                                                                                          notificationArns?: string[];
                                                                                          synthesizer?: IStackSynthesizer;
                                                                                          terminationProtection?: boolean;
                                                                                          analyticsReporting?: boolean;
                                                                                          crossRegionReferences?: boolean;
                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                          suppressTemplateIndentation?: boolean;
                                                                                          pipelineSourceBucket: IBucket;
                                                                                          pipelineSourcePrefix?: string;
                                                                                          pipelineArtifactBucket: Bucket;
                                                                                          ecrRepository: IRepository;
                                                                                          encryptionKey: Key;
                                                                                      }

                                                                                      Hierarchy

                                                                                      • StackProps
                                                                                        • EmbeddedLinuxCodePipelineBaseImageProps
                                                                                      Index

                                                                                      Properties

                                                                                      description? env? stackName? tags? @@ -95,8 +95,8 @@
                                                                                    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                                                                      • pipelineSourceBucket: IBucket

                                                                                      The pipeline source bucket

                                                                                      -
                                                                                      pipelineSourcePrefix?: string

                                                                                      The pipeline source prefix

                                                                                      -
                                                                                      pipelineArtifactBucket: Bucket

                                                                                      Artifact bucket to use

                                                                                      -
                                                                                      ecrRepository: IRepository

                                                                                      The ECR Repository to push to.

                                                                                      -
                                                                                      encryptionKey: Key

                                                                                      The encryption key use across

                                                                                      -

                                                                                      Settings

                                                                                      Member Visibility

                                                                                      On This Page

                                                                                      Properties
                                                                                      +
                                                                                      pipelineSourcePrefix?: string

                                                                                      The pipeline source prefix

                                                                                      +
                                                                                      pipelineArtifactBucket: Bucket

                                                                                      Artifact bucket to use

                                                                                      +
                                                                                      ecrRepository: IRepository

                                                                                      The ECR Repository to push to.

                                                                                      +
                                                                                      encryptionKey: Key

                                                                                      The encryption key use across

                                                                                      +

                                                                                      Settings

                                                                                      Member Visibility

                                                                                      On This Page

                                                                                      Properties
                                                                                      diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 1d5a077..097a03d 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                      aws4embeddedlinux-cdk-lib
                                                                                        Preparing search index...

                                                                                        Interface EmbeddedLinuxCodePipelineProps

                                                                                        Properties to allow customizing the build.

                                                                                        -
                                                                                        interface EmbeddedLinuxCodePipelineProps {
                                                                                            description?: string;
                                                                                            env?: Environment;
                                                                                            stackName?: string;
                                                                                            tags?: { [key: string]: string };
                                                                                            notificationArns?: string[];
                                                                                            synthesizer?: IStackSynthesizer;
                                                                                            terminationProtection?: boolean;
                                                                                            analyticsReporting?: boolean;
                                                                                            crossRegionReferences?: boolean;
                                                                                            permissionsBoundary?: PermissionsBoundary;
                                                                                            suppressTemplateIndentation?: boolean;
                                                                                            pipelineSourceBucket: IBucket;
                                                                                            pipelineSourcePrefix?: string;
                                                                                            pipelineArtifactBucket: Bucket;
                                                                                            pipelineArtifactPrefix?: string;
                                                                                            pipelineOutputBucket: Bucket;
                                                                                            pipelineOutputPrefix?: string;
                                                                                            ecrRepository: IRepository;
                                                                                            ecrRepositoryImageTag: string;
                                                                                            projectType: ProjectType;
                                                                                            vpc: IVpc;
                                                                                            buildPolicyAdditions?: PolicyStatement[];
                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                            encryptionKey: Key;
                                                                                            sourceCustomPath?: string;
                                                                                        }

                                                                                        Hierarchy

                                                                                        • StackProps
                                                                                          • EmbeddedLinuxCodePipelineProps
                                                                                        Index

                                                                                        Properties

                                                                                        description? +
                                                                                        interface EmbeddedLinuxCodePipelineProps {
                                                                                            description?: string;
                                                                                            env?: Environment;
                                                                                            stackName?: string;
                                                                                            tags?: { [key: string]: string };
                                                                                            notificationArns?: string[];
                                                                                            synthesizer?: IStackSynthesizer;
                                                                                            terminationProtection?: boolean;
                                                                                            analyticsReporting?: boolean;
                                                                                            crossRegionReferences?: boolean;
                                                                                            permissionsBoundary?: PermissionsBoundary;
                                                                                            suppressTemplateIndentation?: boolean;
                                                                                            pipelineSourceBucket: IBucket;
                                                                                            pipelineSourcePrefix?: string;
                                                                                            pipelineArtifactBucket: Bucket;
                                                                                            pipelineArtifactPrefix?: string;
                                                                                            pipelineOutputBucket: Bucket;
                                                                                            pipelineOutputPrefix?: string;
                                                                                            ecrRepository: IRepository;
                                                                                            ecrRepositoryImageTag: string;
                                                                                            projectType: ProjectType;
                                                                                            vpc: IVpc;
                                                                                            buildPolicyAdditions?: PolicyStatement[];
                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                            encryptionKey: Key;
                                                                                            sourceCustomPath?: string;
                                                                                        }

                                                                                        Hierarchy

                                                                                        • StackProps
                                                                                          • EmbeddedLinuxCodePipelineProps
                                                                                        Index

                                                                                        Properties

                                                                                        description? env? stackName? tags? @@ -104,17 +104,17 @@
                                                                                      • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                                                                        • pipelineSourceBucket: IBucket

                                                                                        The pipeline source bucket

                                                                                        -
                                                                                        pipelineSourcePrefix?: string

                                                                                        The pipeline source prefix

                                                                                        -
                                                                                        pipelineArtifactBucket: Bucket

                                                                                        The pipeline artifact bucket to use

                                                                                        -
                                                                                        pipelineArtifactPrefix?: string

                                                                                        The pipeline artifact bucket prefix to use

                                                                                        -
                                                                                        pipelineOutputBucket: Bucket

                                                                                        The pipeline output bucket to use

                                                                                        -
                                                                                        pipelineOutputPrefix?: string

                                                                                        The pipeline output bucket prefix to use

                                                                                        -
                                                                                        ecrRepository: IRepository

                                                                                        ECR Repository where the Build Host Image resides.

                                                                                        -
                                                                                        ecrRepositoryImageTag: string

                                                                                        Tag for the Build Host Image

                                                                                        -
                                                                                        projectType: ProjectType

                                                                                        The type of project being built.

                                                                                        -
                                                                                        vpc: IVpc

                                                                                        VPC where the networking setup resides.

                                                                                        -
                                                                                        buildPolicyAdditions?: PolicyStatement[]

                                                                                        Additional policy statements to add to the build project.

                                                                                        -
                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                        Additional build environment variables to the build project.

                                                                                        -
                                                                                        encryptionKey: Key

                                                                                        The encryption key use across

                                                                                        -
                                                                                        sourceCustomPath?: string

                                                                                        Custom asset to be provided when using ProjectType.Custom

                                                                                        -

                                                                                        Settings

                                                                                        Member Visibility

                                                                                        On This Page

                                                                                        Properties
                                                                                        +
                                                                                        pipelineSourcePrefix?: string

                                                                                        The pipeline source prefix

                                                                                        +
                                                                                        pipelineArtifactBucket: Bucket

                                                                                        The pipeline artifact bucket to use

                                                                                        +
                                                                                        pipelineArtifactPrefix?: string

                                                                                        The pipeline artifact bucket prefix to use

                                                                                        +
                                                                                        pipelineOutputBucket: Bucket

                                                                                        The pipeline output bucket to use

                                                                                        +
                                                                                        pipelineOutputPrefix?: string

                                                                                        The pipeline output bucket prefix to use

                                                                                        +
                                                                                        ecrRepository: IRepository

                                                                                        ECR Repository where the Build Host Image resides.

                                                                                        +
                                                                                        ecrRepositoryImageTag: string

                                                                                        Tag for the Build Host Image

                                                                                        +
                                                                                        projectType: ProjectType

                                                                                        The type of project being built.

                                                                                        +
                                                                                        vpc: IVpc

                                                                                        VPC where the networking setup resides.

                                                                                        +
                                                                                        buildPolicyAdditions?: PolicyStatement[]

                                                                                        Additional policy statements to add to the build project.

                                                                                        +
                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                        Additional build environment variables to the build project.

                                                                                        +
                                                                                        encryptionKey: Key

                                                                                        The encryption key use across

                                                                                        +
                                                                                        sourceCustomPath?: string

                                                                                        Custom asset to be provided when using ProjectType.Custom

                                                                                        +

                                                                                        Settings

                                                                                        Member Visibility

                                                                                        On This Page

                                                                                        Properties
                                                                                        diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index a8441cc..c9933c4 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                        aws4embeddedlinux-cdk-lib
                                                                                          Preparing search index...

                                                                                          Interface PipelineResourcesProps

                                                                                          Select options for the PipelineResourcesStack.

                                                                                          -
                                                                                          interface PipelineResourcesProps {
                                                                                              description?: string;
                                                                                              env?: Environment;
                                                                                              stackName?: string;
                                                                                              tags?: { [key: string]: string };
                                                                                              notificationArns?: string[];
                                                                                              synthesizer?: IStackSynthesizer;
                                                                                              terminationProtection?: boolean;
                                                                                              analyticsReporting?: boolean;
                                                                                              crossRegionReferences?: boolean;
                                                                                              permissionsBoundary?: PermissionsBoundary;
                                                                                              suppressTemplateIndentation?: boolean;
                                                                                              resource_prefix: string;
                                                                                              ecrRepositoryName?: string;
                                                                                              pipelineArtifactBucketName?: string;
                                                                                              pipelineSourceBucketName?: string;
                                                                                              pipelineOutputBucketName?: string;
                                                                                              loggingBucketName?: string;
                                                                                          }

                                                                                          Hierarchy

                                                                                          • StackProps
                                                                                            • PipelineResourcesProps
                                                                                          Index

                                                                                          Properties

                                                                                          description? +
                                                                                          interface PipelineResourcesProps {
                                                                                              description?: string;
                                                                                              env?: Environment;
                                                                                              stackName?: string;
                                                                                              tags?: { [key: string]: string };
                                                                                              notificationArns?: string[];
                                                                                              synthesizer?: IStackSynthesizer;
                                                                                              terminationProtection?: boolean;
                                                                                              analyticsReporting?: boolean;
                                                                                              crossRegionReferences?: boolean;
                                                                                              permissionsBoundary?: PermissionsBoundary;
                                                                                              suppressTemplateIndentation?: boolean;
                                                                                              resource_prefix: string;
                                                                                              ecrRepositoryName?: string;
                                                                                              pipelineArtifactBucketName?: string;
                                                                                              pipelineSourceBucketName?: string;
                                                                                              pipelineOutputBucketName?: string;
                                                                                              loggingBucketName?: string;
                                                                                          }

                                                                                          Hierarchy

                                                                                          • StackProps
                                                                                            • PipelineResourcesProps
                                                                                          Index

                                                                                          Properties

                                                                                          description? env? stackName? tags? @@ -96,9 +96,9 @@
                                                                                        • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                                                                          • resource_prefix: string

                                                                                          The resource prefix

                                                                                          -
                                                                                          ecrRepositoryName?: string

                                                                                          The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                          -
                                                                                          pipelineArtifactBucketName?: string

                                                                                          The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                          -
                                                                                          pipelineSourceBucketName?: string

                                                                                          The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                          -
                                                                                          pipelineOutputBucketName?: string

                                                                                          The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                          -
                                                                                          loggingBucketName?: string

                                                                                          Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                          -

                                                                                          Settings

                                                                                          Member Visibility

                                                                                          On This Page

                                                                                          Properties
                                                                                          +
                                                                                          ecrRepositoryName?: string

                                                                                          The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                          +
                                                                                          pipelineArtifactBucketName?: string

                                                                                          The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                          +
                                                                                          pipelineSourceBucketName?: string

                                                                                          The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                          +
                                                                                          pipelineOutputBucketName?: string

                                                                                          The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                          +
                                                                                          loggingBucketName?: string

                                                                                          Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                          +

                                                                                          Settings

                                                                                          Member Visibility

                                                                                          On This Page

                                                                                          Properties
                                                                                          From dd16d19258c22d74b11c874ca81b506b034f2b42 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 15 Jul 2025 07:07:25 +0000 Subject: [PATCH 36/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@642c4537abc3151a92dcbc2a85?= =?UTF-8?q?fc4d48b8c4d0b8=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 538805a..0f08aa7 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                          aws4embeddedlinux-cdk-lib
                                                                                            Preparing search index...

                                                                                            Class EmbeddedLinuxCodeBuildProjectStack

                                                                                            The stack for creating a build pipeline.

                                                                                            See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                            -

                                                                                            Hierarchy

                                                                                            • Stack
                                                                                              • EmbeddedLinuxCodeBuildProjectStack
                                                                                            Index

                                                                                            Constructors

                                                                                            constructor +

                                                                                            Hierarchy

                                                                                            • Stack
                                                                                              • EmbeddedLinuxCodeBuildProjectStack
                                                                                            Index

                                                                                            Constructors

                                                                                            constructor

                                                                                            Properties

                                                                                            tags templateOptions region @@ -50,7 +50,7 @@ _toCloudFormation isConstruct toString -

                                                                                            Constructors

                                                                                            Properties

                                                                                            tags: TagManager

                                                                                            Tags to be applied to the stack.

                                                                                            +

                                                                                            Constructors

                                                                                            Properties

                                                                                            tags: TagManager

                                                                                            Tags to be applied to the stack.

                                                                                            templateOptions: ITemplateOptions

                                                                                            Options for CloudFormation template (like version, transform, description).

                                                                                            region: string

                                                                                            The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                            This value is resolved according to the following rules:

                                                                                            diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index eb356b5..03abfa4 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                            aws4embeddedlinux-cdk-lib
                                                                                              Preparing search index...

                                                                                              Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                              The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                              For configuration options see BuildBaseImageCodePipelineProps.

                                                                                              -

                                                                                              Hierarchy

                                                                                              • Stack
                                                                                                • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                              Index

                                                                                              Constructors

                                                                                              constructor +

                                                                                              Hierarchy

                                                                                              • Stack
                                                                                                • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                              Index

                                                                                              Constructors

                                                                                              constructor

                                                                                              Properties

                                                                                              tags templateOptions region @@ -53,7 +53,7 @@ _toCloudFormation isConstruct toString -

                                                                                              Constructors

                                                                                              Properties

                                                                                              tags: TagManager

                                                                                              Tags to be applied to the stack.

                                                                                              +

                                                                                              Constructors

                                                                                              Properties

                                                                                              tags: TagManager

                                                                                              Tags to be applied to the stack.

                                                                                              templateOptions: ITemplateOptions

                                                                                              Options for CloudFormation template (like version, transform, description).

                                                                                              region: string

                                                                                              The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                              This value is resolved according to the following rules:

                                                                                              @@ -110,8 +110,8 @@

                                                                                              Readonly Internal_crossRegionReferences

                                                                                              _crossRegionReferences: boolean

                                                                                              Whether cross region references are enabled for this stack

                                                                                              Optional Readonly Internal_notificationArns

                                                                                              _notificationArns?: string[]

                                                                                              SNS Notification ARNs to receive stack events.

                                                                                              ecrRepository: IRepository

                                                                                              The ECR Repository where the image is located.

                                                                                              -
                                                                                              ecrRepositoryImageTag: string

                                                                                              The ECR Image Tag to find the base imaged.

                                                                                              -
                                                                                              node: Node

                                                                                              The tree node.

                                                                                              +
                                                                                              ecrRepositoryImageTag: string

                                                                                              The ECR Image Tag to find the base imaged.

                                                                                              +
                                                                                              node: Node

                                                                                              The tree node.

                                                                                              Accessors

                                                                                              • get terminationProtection(): boolean

                                                                                                Whether termination protection is enabled for this stack.

                                                                                                Returns boolean

                                                                                              • set terminationProtection(value: boolean): void

                                                                                                Parameters

                                                                                                • value: boolean

                                                                                                Returns void

                                                                                              • get dependencies(): Stack[]

                                                                                                Return the stacks this stack depends on

                                                                                                Returns Stack[]

                                                                                              ecrRepository: IRepository

                                                                                              ECR Repository where the Build Host Image resides.

                                                                                              -
                                                                                              ecrRepositoryImageTag: string

                                                                                              Tag for the Build Host Image

                                                                                              -
                                                                                              vpc: IVpc

                                                                                              VPC where the networking setup resides.

                                                                                              -
                                                                                              buildPolicyAdditions?: PolicyStatement[]

                                                                                              Additional policy statements to add to the build project.

                                                                                              -
                                                                                              encryptionKey: Key

                                                                                              The encryption key use across

                                                                                              -

                                                                                              Settings

                                                                                              Member Visibility

                                                                                              On This Page

                                                                                              Properties
                                                                                              +
                                                                                              ecrRepositoryImageTag: string

                                                                                              Tag for the Build Host Image

                                                                                              +
                                                                                              vpc: IVpc

                                                                                              VPC where the networking setup resides.

                                                                                              +
                                                                                              buildPolicyAdditions?: PolicyStatement[]

                                                                                              Additional policy statements to add to the build project.

                                                                                              +
                                                                                              encryptionKey: Key

                                                                                              The encryption key use across

                                                                                              +

                                                                                              Settings

                                                                                              Member Visibility

                                                                                              On This Page

                                                                                              Properties
                                                                                              diff --git a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html index ff5f9bf..a8e559a 100644 --- a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineBaseImageProps | aws4embeddedlinux-cdk-lib
                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                Preparing search index...

                                                                                                Interface EmbeddedLinuxCodePipelineBaseImageProps

                                                                                                Select options for the BuildImageCodePipelineStack.

                                                                                                -
                                                                                                interface EmbeddedLinuxCodePipelineBaseImageProps {
                                                                                                    description?: string;
                                                                                                    env?: Environment;
                                                                                                    stackName?: string;
                                                                                                    tags?: { [key: string]: string };
                                                                                                    notificationArns?: string[];
                                                                                                    synthesizer?: IStackSynthesizer;
                                                                                                    terminationProtection?: boolean;
                                                                                                    analyticsReporting?: boolean;
                                                                                                    crossRegionReferences?: boolean;
                                                                                                    permissionsBoundary?: PermissionsBoundary;
                                                                                                    suppressTemplateIndentation?: boolean;
                                                                                                    pipelineSourceBucket: IBucket;
                                                                                                    pipelineSourcePrefix?: string;
                                                                                                    pipelineArtifactBucket: Bucket;
                                                                                                    ecrRepository: IRepository;
                                                                                                    encryptionKey: Key;
                                                                                                }

                                                                                                Hierarchy

                                                                                                • StackProps
                                                                                                  • EmbeddedLinuxCodePipelineBaseImageProps
                                                                                                Index

                                                                                                Properties

                                                                                                description? +
                                                                                                interface EmbeddedLinuxCodePipelineBaseImageProps {
                                                                                                    description?: string;
                                                                                                    env?: Environment;
                                                                                                    stackName?: string;
                                                                                                    tags?: { [key: string]: string };
                                                                                                    notificationArns?: string[];
                                                                                                    synthesizer?: IStackSynthesizer;
                                                                                                    terminationProtection?: boolean;
                                                                                                    analyticsReporting?: boolean;
                                                                                                    crossRegionReferences?: boolean;
                                                                                                    permissionsBoundary?: PermissionsBoundary;
                                                                                                    suppressTemplateIndentation?: boolean;
                                                                                                    pipelineSourceBucket: IBucket;
                                                                                                    pipelineSourcePrefix?: string;
                                                                                                    pipelineArtifactBucket: Bucket;
                                                                                                    ecrRepository: IRepository;
                                                                                                    encryptionKey: Key;
                                                                                                }

                                                                                                Hierarchy

                                                                                                • StackProps
                                                                                                  • EmbeddedLinuxCodePipelineBaseImageProps
                                                                                                Index

                                                                                                Properties

                                                                                                description? env? stackName? tags? @@ -95,8 +95,8 @@
                                                                                              • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                                                                                • pipelineSourceBucket: IBucket

                                                                                                The pipeline source bucket

                                                                                                -
                                                                                                pipelineSourcePrefix?: string

                                                                                                The pipeline source prefix

                                                                                                -
                                                                                                pipelineArtifactBucket: Bucket

                                                                                                Artifact bucket to use

                                                                                                -
                                                                                                ecrRepository: IRepository

                                                                                                The ECR Repository to push to.

                                                                                                -
                                                                                                encryptionKey: Key

                                                                                                The encryption key use across

                                                                                                -

                                                                                                Settings

                                                                                                Member Visibility

                                                                                                On This Page

                                                                                                Properties
                                                                                                +
                                                                                                pipelineSourcePrefix?: string

                                                                                                The pipeline source prefix

                                                                                                +
                                                                                                pipelineArtifactBucket: Bucket

                                                                                                Artifact bucket to use

                                                                                                +
                                                                                                ecrRepository: IRepository

                                                                                                The ECR Repository to push to.

                                                                                                +
                                                                                                encryptionKey: Key

                                                                                                The encryption key use across

                                                                                                +

                                                                                                Settings

                                                                                                Member Visibility

                                                                                                On This Page

                                                                                                Properties
                                                                                                diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 097a03d..c6d72d1 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                  Preparing search index...

                                                                                                  Interface EmbeddedLinuxCodePipelineProps

                                                                                                  Properties to allow customizing the build.

                                                                                                  -
                                                                                                  interface EmbeddedLinuxCodePipelineProps {
                                                                                                      description?: string;
                                                                                                      env?: Environment;
                                                                                                      stackName?: string;
                                                                                                      tags?: { [key: string]: string };
                                                                                                      notificationArns?: string[];
                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                      terminationProtection?: boolean;
                                                                                                      analyticsReporting?: boolean;
                                                                                                      crossRegionReferences?: boolean;
                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                      pipelineSourceBucket: IBucket;
                                                                                                      pipelineSourcePrefix?: string;
                                                                                                      pipelineArtifactBucket: Bucket;
                                                                                                      pipelineArtifactPrefix?: string;
                                                                                                      pipelineOutputBucket: Bucket;
                                                                                                      pipelineOutputPrefix?: string;
                                                                                                      ecrRepository: IRepository;
                                                                                                      ecrRepositoryImageTag: string;
                                                                                                      projectType: ProjectType;
                                                                                                      vpc: IVpc;
                                                                                                      buildPolicyAdditions?: PolicyStatement[];
                                                                                                      environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                      encryptionKey: Key;
                                                                                                      sourceCustomPath?: string;
                                                                                                  }

                                                                                                  Hierarchy

                                                                                                  • StackProps
                                                                                                    • EmbeddedLinuxCodePipelineProps
                                                                                                  Index

                                                                                                  Properties

                                                                                                  description? +
                                                                                                  interface EmbeddedLinuxCodePipelineProps {
                                                                                                      description?: string;
                                                                                                      env?: Environment;
                                                                                                      stackName?: string;
                                                                                                      tags?: { [key: string]: string };
                                                                                                      notificationArns?: string[];
                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                      terminationProtection?: boolean;
                                                                                                      analyticsReporting?: boolean;
                                                                                                      crossRegionReferences?: boolean;
                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                      pipelineSourceBucket: IBucket;
                                                                                                      pipelineSourcePrefix?: string;
                                                                                                      pipelineArtifactBucket: Bucket;
                                                                                                      pipelineArtifactPrefix?: string;
                                                                                                      pipelineOutputBucket: Bucket;
                                                                                                      pipelineOutputPrefix?: string;
                                                                                                      ecrRepository: IRepository;
                                                                                                      ecrRepositoryImageTag: string;
                                                                                                      projectType: ProjectType;
                                                                                                      vpc: IVpc;
                                                                                                      buildPolicyAdditions?: PolicyStatement[];
                                                                                                      environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                      encryptionKey: Key;
                                                                                                      sourceCustomPath?: string;
                                                                                                  }

                                                                                                  Hierarchy

                                                                                                  • StackProps
                                                                                                    • EmbeddedLinuxCodePipelineProps
                                                                                                  Index

                                                                                                  Properties

                                                                                                  description? env? stackName? tags? @@ -104,17 +104,17 @@
                                                                                                • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                                                                                  • pipelineSourceBucket: IBucket

                                                                                                  The pipeline source bucket

                                                                                                  -
                                                                                                  pipelineSourcePrefix?: string

                                                                                                  The pipeline source prefix

                                                                                                  -
                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                  The pipeline artifact bucket to use

                                                                                                  -
                                                                                                  pipelineArtifactPrefix?: string

                                                                                                  The pipeline artifact bucket prefix to use

                                                                                                  -
                                                                                                  pipelineOutputBucket: Bucket

                                                                                                  The pipeline output bucket to use

                                                                                                  -
                                                                                                  pipelineOutputPrefix?: string

                                                                                                  The pipeline output bucket prefix to use

                                                                                                  -
                                                                                                  ecrRepository: IRepository

                                                                                                  ECR Repository where the Build Host Image resides.

                                                                                                  -
                                                                                                  ecrRepositoryImageTag: string

                                                                                                  Tag for the Build Host Image

                                                                                                  -
                                                                                                  projectType: ProjectType

                                                                                                  The type of project being built.

                                                                                                  -
                                                                                                  vpc: IVpc

                                                                                                  VPC where the networking setup resides.

                                                                                                  -
                                                                                                  buildPolicyAdditions?: PolicyStatement[]

                                                                                                  Additional policy statements to add to the build project.

                                                                                                  -
                                                                                                  environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                  Additional build environment variables to the build project.

                                                                                                  -
                                                                                                  encryptionKey: Key

                                                                                                  The encryption key use across

                                                                                                  -
                                                                                                  sourceCustomPath?: string

                                                                                                  Custom asset to be provided when using ProjectType.Custom

                                                                                                  -

                                                                                                  Settings

                                                                                                  Member Visibility

                                                                                                  On This Page

                                                                                                  Properties
                                                                                                  +
                                                                                                  pipelineSourcePrefix?: string

                                                                                                  The pipeline source prefix

                                                                                                  +
                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                  The pipeline artifact bucket to use

                                                                                                  +
                                                                                                  pipelineArtifactPrefix?: string

                                                                                                  The pipeline artifact bucket prefix to use

                                                                                                  +
                                                                                                  pipelineOutputBucket: Bucket

                                                                                                  The pipeline output bucket to use

                                                                                                  +
                                                                                                  pipelineOutputPrefix?: string

                                                                                                  The pipeline output bucket prefix to use

                                                                                                  +
                                                                                                  ecrRepository: IRepository

                                                                                                  ECR Repository where the Build Host Image resides.

                                                                                                  +
                                                                                                  ecrRepositoryImageTag: string

                                                                                                  Tag for the Build Host Image

                                                                                                  +
                                                                                                  projectType: ProjectType

                                                                                                  The type of project being built.

                                                                                                  +
                                                                                                  vpc: IVpc

                                                                                                  VPC where the networking setup resides.

                                                                                                  +
                                                                                                  buildPolicyAdditions?: PolicyStatement[]

                                                                                                  Additional policy statements to add to the build project.

                                                                                                  +
                                                                                                  environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                  Additional build environment variables to the build project.

                                                                                                  +
                                                                                                  encryptionKey: Key

                                                                                                  The encryption key use across

                                                                                                  +
                                                                                                  sourceCustomPath?: string

                                                                                                  Custom asset to be provided when using ProjectType.Custom

                                                                                                  +

                                                                                                  Settings

                                                                                                  Member Visibility

                                                                                                  On This Page

                                                                                                  Properties
                                                                                                  diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index c9933c4..2f46b8f 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                    Preparing search index...

                                                                                                    Interface PipelineResourcesProps

                                                                                                    Select options for the PipelineResourcesStack.

                                                                                                    -
                                                                                                    interface PipelineResourcesProps {
                                                                                                        description?: string;
                                                                                                        env?: Environment;
                                                                                                        stackName?: string;
                                                                                                        tags?: { [key: string]: string };
                                                                                                        notificationArns?: string[];
                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                        terminationProtection?: boolean;
                                                                                                        analyticsReporting?: boolean;
                                                                                                        crossRegionReferences?: boolean;
                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                        resource_prefix: string;
                                                                                                        ecrRepositoryName?: string;
                                                                                                        pipelineArtifactBucketName?: string;
                                                                                                        pipelineSourceBucketName?: string;
                                                                                                        pipelineOutputBucketName?: string;
                                                                                                        loggingBucketName?: string;
                                                                                                    }

                                                                                                    Hierarchy

                                                                                                    • StackProps
                                                                                                      • PipelineResourcesProps
                                                                                                    Index

                                                                                                    Properties

                                                                                                    description? +
                                                                                                    interface PipelineResourcesProps {
                                                                                                        description?: string;
                                                                                                        env?: Environment;
                                                                                                        stackName?: string;
                                                                                                        tags?: { [key: string]: string };
                                                                                                        notificationArns?: string[];
                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                        terminationProtection?: boolean;
                                                                                                        analyticsReporting?: boolean;
                                                                                                        crossRegionReferences?: boolean;
                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                        resource_prefix: string;
                                                                                                        ecrRepositoryName?: string;
                                                                                                        pipelineArtifactBucketName?: string;
                                                                                                        pipelineSourceBucketName?: string;
                                                                                                        pipelineOutputBucketName?: string;
                                                                                                        loggingBucketName?: string;
                                                                                                    }

                                                                                                    Hierarchy

                                                                                                    • StackProps
                                                                                                      • PipelineResourcesProps
                                                                                                    Index

                                                                                                    Properties

                                                                                                    description? env? stackName? tags? @@ -96,9 +96,9 @@
                                                                                                  • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                                                                                    • resource_prefix: string

                                                                                                    The resource prefix

                                                                                                    -
                                                                                                    ecrRepositoryName?: string

                                                                                                    The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                    -
                                                                                                    pipelineArtifactBucketName?: string

                                                                                                    The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                    -
                                                                                                    pipelineSourceBucketName?: string

                                                                                                    The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                    -
                                                                                                    pipelineOutputBucketName?: string

                                                                                                    The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                    -
                                                                                                    loggingBucketName?: string

                                                                                                    Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                    -

                                                                                                    Settings

                                                                                                    Member Visibility

                                                                                                    On This Page

                                                                                                    Properties
                                                                                                    +
                                                                                                    ecrRepositoryName?: string

                                                                                                    The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                    +
                                                                                                    pipelineArtifactBucketName?: string

                                                                                                    The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                    +
                                                                                                    pipelineSourceBucketName?: string

                                                                                                    The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                    +
                                                                                                    pipelineOutputBucketName?: string

                                                                                                    The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                    +
                                                                                                    loggingBucketName?: string

                                                                                                    Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                    +

                                                                                                    Settings

                                                                                                    Member Visibility

                                                                                                    On This Page

                                                                                                    Properties
                                                                                                    From dc18fb1507df17e3486613cb81b55ed94f645e91 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 21 Jul 2025 19:53:58 +0000 Subject: [PATCH 37/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@452415261979c6c7c5a7cf88b6?= =?UTF-8?q?483737f3040daf=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 104 +++++++-------- ...beddedLinuxCodePipelineBaseImageStack.html | 108 ++++++++-------- classes/EmbeddedLinuxCodePipelineStack.html | 104 +++++++-------- classes/PipelineResourcesStack.html | 118 +++++++++--------- enums/ProjectType.html | 18 +-- .../EmbeddedLinuxCodeBuildProjectProps.html | 45 ++++--- ...beddedLinuxCodePipelineBaseImageProps.html | 45 ++++--- .../EmbeddedLinuxCodePipelineProps.html | 63 ++++++---- interfaces/PipelineResourcesProps.html | 47 ++++--- 9 files changed, 360 insertions(+), 292 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 0f08aa7..3609c17 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                    aws4embeddedlinux-cdk-lib
                                                                                                      Preparing search index...

                                                                                                      Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                      The stack for creating a build pipeline.

                                                                                                      See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                      -

                                                                                                      Hierarchy

                                                                                                      • Stack
                                                                                                        • EmbeddedLinuxCodeBuildProjectStack
                                                                                                      Index

                                                                                                      Constructors

                                                                                                      constructor +

                                                                                                      Hierarchy

                                                                                                      • Stack
                                                                                                        • EmbeddedLinuxCodeBuildProjectStack
                                                                                                      Index

                                                                                                      Constructors

                                                                                                      constructor

                                                                                                      Properties

                                                                                                      tags templateOptions region @@ -48,11 +48,13 @@ allocateLogicalId _validateId _toCloudFormation +addStackTag +removeStackTag isConstruct toString -

                                                                                                      Constructors

                                                                                                      Properties

                                                                                                      tags: TagManager

                                                                                                      Tags to be applied to the stack.

                                                                                                      -
                                                                                                      templateOptions: ITemplateOptions

                                                                                                      Options for CloudFormation template (like version, transform, description).

                                                                                                      -
                                                                                                      region: string

                                                                                                      The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                      +

                                                                                                      Constructors

                                                                                                      Properties

                                                                                                      tags: TagManager

                                                                                                      Tags to be applied to the stack.

                                                                                                      +
                                                                                                      templateOptions: ITemplateOptions

                                                                                                      Options for CloudFormation template (like version, transform, description).

                                                                                                      +
                                                                                                      region: string

                                                                                                      The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                      This value is resolved according to the following rules:

                                                                                                      1. The value provided to env.region when the stack is defined. This can @@ -69,7 +71,7 @@ into a region-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

                                                                                                        -
                                                                                                      account: string

                                                                                                      The AWS account into which this stack will be deployed.

                                                                                                      +
                                                                                                      account: string

                                                                                                      The AWS account into which this stack will be deployed.

                                                                                                      This value is resolved according to the following rules:

                                                                                                      1. The value provided to env.account when the stack is defined. This can @@ -86,7 +88,7 @@ into an account-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other account-agnostic behavior.

                                                                                                        -
                                                                                                      environment: string

                                                                                                      The environment coordinates in which this stack is deployed. In the form +

                                                                                                      environment: string

                                                                                                      The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

                                                                                                      You can use this value to determine if two stacks are targeting the same @@ -95,21 +97,21 @@ Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

                                                                                                      -
                                                                                                      nestedStackResource?: CfnResource

                                                                                                      If this is a nested stack, this represents its AWS::CloudFormation::Stack +

                                                                                                      nestedStackResource?: CfnResource

                                                                                                      If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

                                                                                                      -
                                                                                                      templateFile: string

                                                                                                      The name of the CloudFormation template file emitted to the output +

                                                                                                      templateFile: string

                                                                                                      The name of the CloudFormation template file emitted to the output directory during synthesis.

                                                                                                      Example value: MyStack.template.json

                                                                                                      -
                                                                                                      artifactId: string

                                                                                                      The ID of the cloud assembly artifact for this stack.

                                                                                                      -
                                                                                                      synthesizer: IStackSynthesizer

                                                                                                      Synthesis method for this stack

                                                                                                      -

                                                                                                      Readonly Internal_versionReportingEnabled

                                                                                                      _versionReportingEnabled: boolean

                                                                                                      Whether version reporting is enabled for this stack

                                                                                                      +
                                                                                                      artifactId: string

                                                                                                      The ID of the cloud assembly artifact for this stack.

                                                                                                      +
                                                                                                      synthesizer: IStackSynthesizer

                                                                                                      Synthesis method for this stack

                                                                                                      +

                                                                                                      Readonly Internal_versionReportingEnabled

                                                                                                      _versionReportingEnabled: boolean

                                                                                                      Whether version reporting is enabled for this stack

                                                                                                      Controls whether the CDK Metadata resource is injected

                                                                                                      -

                                                                                                      Readonly Internal_crossRegionReferences

                                                                                                      _crossRegionReferences: boolean

                                                                                                      Whether cross region references are enabled for this stack

                                                                                                      -

                                                                                                      Optional Readonly Internal_notificationArns

                                                                                                      _notificationArns?: string[]

                                                                                                      SNS Notification ARNs to receive stack events.

                                                                                                      -
                                                                                                      node: Node

                                                                                                      The tree node.

                                                                                                      +

                                                                                                      Readonly Internal_crossRegionReferences

                                                                                                      _crossRegionReferences: boolean

                                                                                                      Whether cross region references are enabled for this stack

                                                                                                      +

                                                                                                      Optional Readonly Internal_notificationArns

                                                                                                      _notificationArns?: string[]

                                                                                                      SNS Notification ARNs to receive stack events.

                                                                                                      +
                                                                                                      node: Node

                                                                                                      The tree node.

                                                                                                      Accessors

                                                                                                      • get terminationProtection(): boolean

                                                                                                        Whether termination protection is enabled for this stack.

                                                                                                        -

                                                                                                        Returns boolean

                                                                                                      • set terminationProtection(value: boolean): void

                                                                                                        Parameters

                                                                                                        • value: boolean

                                                                                                        Returns void

                                                                                                      • get dependencies(): Stack[]

                                                                                                        Return the stacks this stack depends on

                                                                                                        -

                                                                                                        Returns Stack[]

                                                                                                      • get stackName(): string

                                                                                                        The concrete CloudFormation physical stack name.

                                                                                                        +

                                                                                                        Returns boolean

                                                                                                      • set terminationProtection(value: boolean): void

                                                                                                        Parameters

                                                                                                        • value: boolean

                                                                                                        Returns void

                                                                                                      • get dependencies(): Stack[]

                                                                                                        Return the stacks this stack depends on

                                                                                                        +

                                                                                                        Returns Stack[]

                                                                                                      • get stackName(): string

                                                                                                        The concrete CloudFormation physical stack name.

                                                                                                        This is either the name defined explicitly in the stackName prop or allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack @@ -117,15 +119,15 @@ scheme based on the construct path to ensure uniqueness.

                                                                                                        If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.

                                                                                                        -

                                                                                                        Returns string

                                                                                                      • get partition(): string

                                                                                                        The partition in which this stack is defined

                                                                                                        -

                                                                                                        Returns string

                                                                                                      • get urlSuffix(): string

                                                                                                        The Amazon domain suffix for the region in which this stack is defined

                                                                                                        -

                                                                                                        Returns string

                                                                                                      • get stackId(): string

                                                                                                        The ID of the stack

                                                                                                        +

                                                                                                        Returns string

                                                                                                      • get partition(): string

                                                                                                        The partition in which this stack is defined

                                                                                                        +

                                                                                                        Returns string

                                                                                                      • get urlSuffix(): string

                                                                                                        The Amazon domain suffix for the region in which this stack is defined

                                                                                                        +

                                                                                                        Returns string

                                                                                                      • get stackId(): string

                                                                                                        The ID of the stack

                                                                                                        Returns string

                                                                                                        // After resolving, looks like
                                                                                                        'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
                                                                                                        -
                                                                                                      • get notificationArns(): string[]

                                                                                                        Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

                                                                                                        -

                                                                                                        Returns string[]

                                                                                                      • get nested(): boolean

                                                                                                        Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

                                                                                                        -

                                                                                                        Returns boolean

                                                                                                      • get availabilityZones(): string[]

                                                                                                        Returns the list of AZs that are available in the AWS environment +

                                                                                                      • get notificationArns(): string[]

                                                                                                        Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

                                                                                                        +

                                                                                                        Returns string[]

                                                                                                      • get nested(): boolean

                                                                                                        Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

                                                                                                        +

                                                                                                        Returns boolean

                                                                                                      • get availabilityZones(): string[]

                                                                                                        Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

                                                                                                        If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve @@ -135,23 +137,23 @@ reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

                                                                                                        To specify a different strategy for selecting availability zones override this method.

                                                                                                        -

                                                                                                        Returns string[]

                                                                                                      • get nestedStackParent(): undefined | Stack

                                                                                                        If this is a nested stack, returns it's parent stack.

                                                                                                        -

                                                                                                        Returns undefined | Stack

                                                                                                      • get bundlingRequired(): boolean

                                                                                                        Indicates whether the stack requires bundling or not

                                                                                                        -

                                                                                                        Returns boolean

                                                                                                      Methods

                                                                                                      • Return whether the given object is a Stack.

                                                                                                        +

                                                                                                        Returns string[]

                                                                                                      • get nestedStackParent(): undefined | Stack

                                                                                                        If this is a nested stack, returns it's parent stack.

                                                                                                        +

                                                                                                        Returns undefined | Stack

                                                                                                      • get bundlingRequired(): boolean

                                                                                                        Indicates whether the stack requires bundling or not

                                                                                                        +

                                                                                                        Returns boolean

                                                                                                      Methods

                                                                                                      • Return whether the given object is a Stack.

                                                                                                        We do attribute detection since we can't reliably use 'instanceof'.

                                                                                                        -

                                                                                                        Parameters

                                                                                                        • this: void
                                                                                                        • x: any

                                                                                                        Returns x is Stack

                                                                                                      • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

                                                                                                        +

                                                                                                        Parameters

                                                                                                        • this: void
                                                                                                        • x: any

                                                                                                        Returns x is Stack

                                                                                                      • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

                                                                                                        Parameters

                                                                                                        • construct: IConstruct

                                                                                                          The construct to start the search from.

                                                                                                          -

                                                                                                        Returns Stack

                                                                                                      • Resolve a tokenized value in the context of the current stack.

                                                                                                        -

                                                                                                        Parameters

                                                                                                        • obj: any

                                                                                                        Returns any

                                                                                                      • Convert an object, potentially containing tokens, to a JSON string

                                                                                                        -

                                                                                                        Parameters

                                                                                                        • this: void
                                                                                                        • obj: any
                                                                                                        • Optionalspace: number

                                                                                                        Returns string

                                                                                                      • Convert an object, potentially containing tokens, to a YAML string

                                                                                                        -

                                                                                                        Parameters

                                                                                                        • obj: any

                                                                                                        Returns string

                                                                                                      • Indicate that a context key was expected

                                                                                                        +

                                                                                                      Returns Stack

                                                                                                      • Resolve a tokenized value in the context of the current stack.

                                                                                                        +

                                                                                                        Parameters

                                                                                                        • obj: any

                                                                                                        Returns any

                                                                                                      • Convert an object, potentially containing tokens, to a JSON string

                                                                                                        +

                                                                                                        Parameters

                                                                                                        • this: void
                                                                                                        • obj: any
                                                                                                        • Optionalspace: number

                                                                                                        Returns string

                                                                                                      • Convert an object, potentially containing tokens, to a YAML string

                                                                                                        +

                                                                                                        Parameters

                                                                                                        • obj: any

                                                                                                        Returns string

                                                                                                      • Indicate that a context key was expected

                                                                                                        Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

                                                                                                        Parameters

                                                                                                        • report: MissingContext

                                                                                                          The set of parameters needed to obtain the context

                                                                                                          -

                                                                                                        Returns void

                                                                                                      • Rename a generated logical identities

                                                                                                        +

                                                                                                      Returns void

                                                                                                      • Rename a generated logical identities

                                                                                                        To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

                                                                                                        -

                                                                                                        Parameters

                                                                                                        • oldId: string
                                                                                                        • newId: string

                                                                                                        Returns void

                                                                                                      • Allocates a stack-unique CloudFormation-compatible logical identity for a +

                                                                                                        Parameters

                                                                                                        • oldId: string
                                                                                                        • newId: string

                                                                                                        Returns void

                                                                                                      • Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.

                                                                                                        This method is called when a CfnElement is created and used to render the initial logical identity of resources. Logical ID renames are applied at @@ -161,10 +163,10 @@ class and override this method.

                                                                                                        Parameters

                                                                                                        • element: CfnElement

                                                                                                          The CloudFormation element for which a logical identity is needed.

                                                                                                          -

                                                                                                        Returns string

                                                                                                      • Add a dependency between this stack and another stack.

                                                                                                        +

                                                                                                      Returns string

                                                                                                      • Add a dependency between this stack and another stack.

                                                                                                        This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

                                                                                                        -

                                                                                                        Parameters

                                                                                                        • target: Stack
                                                                                                        • Optionalreason: string

                                                                                                        Returns void

                                                                                                      • Creates an ARN from components.

                                                                                                        +

                                                                                                        Parameters

                                                                                                        • target: Stack
                                                                                                        • Optionalreason: string

                                                                                                        Returns void

                                                                                                      • Creates an ARN from components.

                                                                                                        If partition, region or account are not specified, the stack's partition, region and account will be used.

                                                                                                        If any component is the empty string, an empty string will be inserted @@ -174,14 +176,14 @@

                                                                                                        The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'.

                                                                                                        -

                                                                                                        Parameters

                                                                                                        • components: ArnComponents

                                                                                                        Returns string

                                                                                                      • Splits the provided ARN into its components. +

                                                                                                        Parameters

                                                                                                        • components: ArnComponents

                                                                                                        Returns string

                                                                                                      • Splits the provided ARN into its components. Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

                                                                                                        Parameters

                                                                                                        • arn: string

                                                                                                          the ARN to split into its components

                                                                                                        • arnFormat: ArnFormat

                                                                                                          the expected format of 'arn' - depends on what format the service 'arn' represents uses

                                                                                                          -

                                                                                                        Returns ArnComponents

                                                                                                      • Add a Transform to this stack. A Transform is a macro that AWS +

                                                                                                      Returns ArnComponents

                                                                                                      • Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.

                                                                                                        Duplicate values are removed when stack is synthesized.

                                                                                                        Parameters

                                                                                                        • transform: string

                                                                                                          The transform to add

                                                                                                          @@ -189,22 +191,22 @@ 
                                                                                                          declare const stack: Stack;

                                                                                                          stack.addTransform('AWS::Serverless-2016-10-31')
                                                                                                          -

                                                                                                      • Adds an arbitrary key-value pair, with information you want to record about the stack. +

                                                                                                      _addAssemblyDependency

                                                                                                      • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
                                                                                                        Internal

                                                                                                        Called implicitly by the addDependency helper function in order to +

                                                                                                      _addAssemblyDependency

                                                                                                      • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
                                                                                                        Internal

                                                                                                        Called implicitly by the addDependency helper function in order to realize a dependency between two top-level stacks at the assembly level.

                                                                                                        Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

                                                                                                        -

                                                                                                        Parameters

                                                                                                        • target: Stack
                                                                                                        • Optionalreason: StackDependencyReason

                                                                                                        Returns void

                                                                                                      _obtainAssemblyDependencies

                                                                                                      • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
                                                                                                        Internal

                                                                                                        Called implicitly by the obtainDependencies helper function in order to +

                                                                                                        Parameters

                                                                                                        • target: Stack
                                                                                                        • Optionalreason: StackDependencyReason

                                                                                                        Returns void

                                                                                                      _obtainAssemblyDependencies

                                                                                                      • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
                                                                                                        Internal

                                                                                                        Called implicitly by the obtainDependencies helper function in order to collect resource dependencies across two top-level stacks at the assembly level.

                                                                                                        Use stack.obtainDependencies to see the dependencies between any two stacks.

                                                                                                        -

                                                                                                        Parameters

                                                                                                        • reasonFilter: StackDependencyReason

                                                                                                        Returns Element[]

                                                                                                      _removeAssemblyDependency

                                                                                                      • _removeAssemblyDependency(
                                                                                                            target: Stack,
                                                                                                            reasonFilter?: StackDependencyReason,
                                                                                                        ): void
                                                                                                        Internal

                                                                                                        Called implicitly by the removeDependency helper function in order to +

                                                                                                        Parameters

                                                                                                        • reasonFilter: StackDependencyReason

                                                                                                        Returns Element[]

                                                                                                      _removeAssemblyDependency

                                                                                                      • _removeAssemblyDependency(
                                                                                                            target: Stack,
                                                                                                            reasonFilter?: StackDependencyReason,
                                                                                                        ): void
                                                                                                        Internal

                                                                                                        Called implicitly by the removeDependency helper function in order to remove a dependency between two top-level stacks at the assembly level.

                                                                                                        Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

                                                                                                        -

                                                                                                        Parameters

                                                                                                        • target: Stack
                                                                                                        • OptionalreasonFilter: StackDependencyReason

                                                                                                        Returns void

                                                                                                      _synthesizeTemplate

                                                                                                      • _synthesizeTemplate(
                                                                                                            session: ISynthesisSession,
                                                                                                            lookupRoleArn?: string,
                                                                                                            lookupRoleExternalId?: string,
                                                                                                            lookupRoleAdditionalOptions?: { [key: string]: any },
                                                                                                        ): void
                                                                                                        Internal

                                                                                                        Synthesizes the cloudformation template into a cloud assembly.

                                                                                                        -

                                                                                                        Parameters

                                                                                                        • session: ISynthesisSession
                                                                                                        • OptionallookupRoleArn: string
                                                                                                        • OptionallookupRoleExternalId: string
                                                                                                        • OptionallookupRoleAdditionalOptions: { [key: string]: any }

                                                                                                        Returns void

                                                                                                      • Look up a fact value for the given fact for the region of this stack

                                                                                                        +

                                                                                                        Parameters

                                                                                                        • target: Stack
                                                                                                        • OptionalreasonFilter: StackDependencyReason

                                                                                                        Returns void

                                                                                                      _synthesizeTemplate

                                                                                                      • _synthesizeTemplate(
                                                                                                            session: ISynthesisSession,
                                                                                                            lookupRoleArn?: string,
                                                                                                            lookupRoleExternalId?: string,
                                                                                                            lookupRoleAdditionalOptions?: { [key: string]: any },
                                                                                                        ): void
                                                                                                        Internal

                                                                                                        Synthesizes the cloudformation template into a cloud assembly.

                                                                                                        +

                                                                                                        Parameters

                                                                                                        • session: ISynthesisSession
                                                                                                        • OptionallookupRoleArn: string
                                                                                                        • OptionallookupRoleExternalId: string
                                                                                                        • OptionallookupRoleAdditionalOptions: { [key: string]: any }

                                                                                                        Returns void

                                                                                                      • Look up a fact value for the given fact for the region of this stack

                                                                                                        Will return a definite value only if the region of the current stack is resolved. If not, a lookup map will be added to the stack and the lookup will be done at CDK deployment time.

                                                                                                        @@ -217,7 +219,7 @@ not have to worry about regional facts.

                                                                                                        If defaultValue is not given, it is an error if the fact is unknown for the given region.

                                                                                                        -

                                                                                                        Parameters

                                                                                                        • factName: string
                                                                                                        • OptionaldefaultValue: string

                                                                                                        Returns string

                                                                                                      • Create a CloudFormation Export for a string value

                                                                                                        +

                                                                                                        Parameters

                                                                                                        • factName: string
                                                                                                        • OptionaldefaultValue: string

                                                                                                        Returns string

                                                                                                      • Create a CloudFormation Export for a string value

                                                                                                        Returns a string representing the corresponding Fn.importValue() expression for this Export. You can control the name for the export by passing the name option.

                                                                                                        @@ -253,7 +255,7 @@
                                                                                                      • Don't forget to remove the exportValue() call as well.
                                                                                                      • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
                                                                                                      -

                                                                                                      Parameters

                                                                                                      • exportedValue: any
                                                                                                      • Optionaloptions: ExportValueOptions

                                                                                                      Returns string

                                                                                                      • Create a CloudFormation Export for a string list value

                                                                                                        +

                                                                                                        Parameters

                                                                                                        • exportedValue: any
                                                                                                        • Optionaloptions: ExportValueOptions

                                                                                                        Returns string

                                                                                                      • Create a CloudFormation Export for a string list value

                                                                                                        Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only @@ -268,7 +270,7 @@ remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

                                                                                                        See exportValue for an example of this process.

                                                                                                        -

                                                                                                        Parameters

                                                                                                        • exportedValue: any
                                                                                                        • Optionaloptions: ExportValueOptions

                                                                                                        Returns string[]

                                                                                                      • Returns the naming scheme used to allocate logical IDs. By default, uses +

                                                                                                        Parameters

                                                                                                        • exportedValue: any
                                                                                                        • Optionaloptions: ExportValueOptions

                                                                                                        Returns string[]

                                                                                                      • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize this behavior.

                                                                                                        In order to make sure logical IDs are unique and stable, we hash the resource @@ -300,12 +302,16 @@ part of the identifier.

                                                                                                      Parameters

                                                                                                      • cfnElement: CfnElement

                                                                                                        The element for which the logical ID is allocated.

                                                                                                        -

                                                                                                      Returns string

                                                                                                      Protected_validateId

                                                                                                      • _validateId(name: string): void
                                                                                                        Internal

                                                                                                        Validate stack name

                                                                                                        +

                                                                                                      Returns string

                                                                                                      Protected_validateId

                                                                                                      • _validateId(name: string): void
                                                                                                        Internal

                                                                                                        Validate stack name

                                                                                                        CloudFormation stack names can include dashes in addition to the regular identifier character classes, and we don't allow one of the magic markers.

                                                                                                        -

                                                                                                        Parameters

                                                                                                        • name: string

                                                                                                        Returns void

                                                                                                      Protected_toCloudFormation

                                                                                                      • _toCloudFormation(): any
                                                                                                        Internal

                                                                                                        Returns the CloudFormation template for this stack by traversing +

                                                                                                        Parameters

                                                                                                        • name: string

                                                                                                        Returns void

                                                                                                      Protected_toCloudFormation

                                                                                                      • _toCloudFormation(): any
                                                                                                        Internal

                                                                                                        Returns the CloudFormation template for this stack by traversing the tree and invoking _toCloudFormation() on all Entity objects.

                                                                                                        -

                                                                                                        Returns any

                                                                                                      • Checks if x is a construct.

                                                                                                        +

                                                                                                        Returns any

                                                                                                      • Configure a stack tag

                                                                                                        +

                                                                                                        At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.

                                                                                                        +

                                                                                                        Parameters

                                                                                                        • tagName: string
                                                                                                        • tagValue: string

                                                                                                        Returns void

                                                                                                      • Remove a stack tag

                                                                                                        +

                                                                                                        At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.

                                                                                                        +

                                                                                                        Parameters

                                                                                                        • tagName: string

                                                                                                        Returns void

                                                                                                      • Checks if x is a construct.

                                                                                                        Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

                                                                                                        Explanation: in JavaScript, multiple copies of the constructs library on @@ -321,4 +327,4 @@

                                                                                                        Parameters

                                                                                                        • x: any

                                                                                                          Any object

                                                                                                        Returns x is Construct

                                                                                                        true if x is an object created from a class which extends Construct.

                                                                                                      • Returns a string representation of this construct.

                                                                                                        -

                                                                                                        Returns string

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      On This Page

                                                                                                      Constructors
                                                                                                      Properties
                                                                                                      Accessors
                                                                                                      Methods
                                                                                                      +

                                                                                                      Returns string

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      On This Page

                                                                                                      Constructors
                                                                                                      Properties
                                                                                                      Accessors
                                                                                                      Methods
                                                                                                      diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 03abfa4..bfe0ea3 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                      aws4embeddedlinux-cdk-lib
                                                                                                        Preparing search index...

                                                                                                        Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                        The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                        For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                        -

                                                                                                        Hierarchy

                                                                                                        • Stack
                                                                                                          • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                        Index

                                                                                                        Constructors

                                                                                                        constructor +

                                                                                                        Hierarchy

                                                                                                        • Stack
                                                                                                          • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                        Index

                                                                                                        Constructors

                                                                                                        constructor

                                                                                                        Properties

                                                                                                        tags templateOptions region @@ -51,11 +51,13 @@ allocateLogicalId _validateId _toCloudFormation +addStackTag +removeStackTag isConstruct toString -

                                                                                                        Constructors

                                                                                                        Properties

                                                                                                        tags: TagManager

                                                                                                        Tags to be applied to the stack.

                                                                                                        -
                                                                                                        templateOptions: ITemplateOptions

                                                                                                        Options for CloudFormation template (like version, transform, description).

                                                                                                        -
                                                                                                        region: string

                                                                                                        The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                        +

                                                                                                        Constructors

                                                                                                        Properties

                                                                                                        tags: TagManager

                                                                                                        Tags to be applied to the stack.

                                                                                                        +
                                                                                                        templateOptions: ITemplateOptions

                                                                                                        Options for CloudFormation template (like version, transform, description).

                                                                                                        +
                                                                                                        region: string

                                                                                                        The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                        This value is resolved according to the following rules:

                                                                                                        1. The value provided to env.region when the stack is defined. This can @@ -72,7 +74,7 @@ into a region-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

                                                                                                          -
                                                                                                        account: string

                                                                                                        The AWS account into which this stack will be deployed.

                                                                                                        +
                                                                                                        account: string

                                                                                                        The AWS account into which this stack will be deployed.

                                                                                                        This value is resolved according to the following rules:

                                                                                                        1. The value provided to env.account when the stack is defined. This can @@ -89,7 +91,7 @@ into an account-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other account-agnostic behavior.

                                                                                                          -
                                                                                                        environment: string

                                                                                                        The environment coordinates in which this stack is deployed. In the form +

                                                                                                        environment: string

                                                                                                        The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

                                                                                                        You can use this value to determine if two stacks are targeting the same @@ -98,23 +100,23 @@ Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

                                                                                                        -
                                                                                                        nestedStackResource?: CfnResource

                                                                                                        If this is a nested stack, this represents its AWS::CloudFormation::Stack +

                                                                                                        nestedStackResource?: CfnResource

                                                                                                        If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

                                                                                                        -
                                                                                                        templateFile: string

                                                                                                        The name of the CloudFormation template file emitted to the output +

                                                                                                        templateFile: string

                                                                                                        The name of the CloudFormation template file emitted to the output directory during synthesis.

                                                                                                        Example value: MyStack.template.json

                                                                                                        -
                                                                                                        artifactId: string

                                                                                                        The ID of the cloud assembly artifact for this stack.

                                                                                                        -
                                                                                                        synthesizer: IStackSynthesizer

                                                                                                        Synthesis method for this stack

                                                                                                        -

                                                                                                        Readonly Internal_versionReportingEnabled

                                                                                                        _versionReportingEnabled: boolean

                                                                                                        Whether version reporting is enabled for this stack

                                                                                                        +
                                                                                                        artifactId: string

                                                                                                        The ID of the cloud assembly artifact for this stack.

                                                                                                        +
                                                                                                        synthesizer: IStackSynthesizer

                                                                                                        Synthesis method for this stack

                                                                                                        +

                                                                                                        Readonly Internal_versionReportingEnabled

                                                                                                        _versionReportingEnabled: boolean

                                                                                                        Whether version reporting is enabled for this stack

                                                                                                        Controls whether the CDK Metadata resource is injected

                                                                                                        -

                                                                                                        Readonly Internal_crossRegionReferences

                                                                                                        _crossRegionReferences: boolean

                                                                                                        Whether cross region references are enabled for this stack

                                                                                                        -

                                                                                                        Optional Readonly Internal_notificationArns

                                                                                                        _notificationArns?: string[]

                                                                                                        SNS Notification ARNs to receive stack events.

                                                                                                        -
                                                                                                        ecrRepository: IRepository

                                                                                                        The ECR Repository where the image is located.

                                                                                                        -
                                                                                                        ecrRepositoryImageTag: string

                                                                                                        The ECR Image Tag to find the base imaged.

                                                                                                        -
                                                                                                        node: Node

                                                                                                        The tree node.

                                                                                                        +

                                                                                                        Readonly Internal_crossRegionReferences

                                                                                                        _crossRegionReferences: boolean

                                                                                                        Whether cross region references are enabled for this stack

                                                                                                        +

                                                                                                        Optional Readonly Internal_notificationArns

                                                                                                        _notificationArns?: string[]

                                                                                                        SNS Notification ARNs to receive stack events.

                                                                                                        +
                                                                                                        ecrRepository: IRepository

                                                                                                        The ECR Repository where the image is located.

                                                                                                        +
                                                                                                        ecrRepositoryImageTag: string

                                                                                                        The ECR Image Tag to find the base imaged.

                                                                                                        +
                                                                                                        node: Node

                                                                                                        The tree node.

                                                                                                        Accessors

                                                                                                        • get terminationProtection(): boolean

                                                                                                          Whether termination protection is enabled for this stack.

                                                                                                          -

                                                                                                          Returns boolean

                                                                                                        • set terminationProtection(value: boolean): void

                                                                                                          Parameters

                                                                                                          • value: boolean

                                                                                                          Returns void

                                                                                                        • get dependencies(): Stack[]

                                                                                                          Return the stacks this stack depends on

                                                                                                          -

                                                                                                          Returns Stack[]

                                                                                                        • get stackName(): string

                                                                                                          The concrete CloudFormation physical stack name.

                                                                                                          +

                                                                                                          Returns boolean

                                                                                                        • set terminationProtection(value: boolean): void

                                                                                                          Parameters

                                                                                                          • value: boolean

                                                                                                          Returns void

                                                                                                        • get dependencies(): Stack[]

                                                                                                          Return the stacks this stack depends on

                                                                                                          +

                                                                                                          Returns Stack[]

                                                                                                        • get stackName(): string

                                                                                                          The concrete CloudFormation physical stack name.

                                                                                                          This is either the name defined explicitly in the stackName prop or allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack @@ -122,15 +124,15 @@ scheme based on the construct path to ensure uniqueness.

                                                                                                          If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.

                                                                                                          -

                                                                                                          Returns string

                                                                                                        • get partition(): string

                                                                                                          The partition in which this stack is defined

                                                                                                          -

                                                                                                          Returns string

                                                                                                        • get urlSuffix(): string

                                                                                                          The Amazon domain suffix for the region in which this stack is defined

                                                                                                          -

                                                                                                          Returns string

                                                                                                        • get stackId(): string

                                                                                                          The ID of the stack

                                                                                                          +

                                                                                                          Returns string

                                                                                                        • get partition(): string

                                                                                                          The partition in which this stack is defined

                                                                                                          +

                                                                                                          Returns string

                                                                                                        • get urlSuffix(): string

                                                                                                          The Amazon domain suffix for the region in which this stack is defined

                                                                                                          +

                                                                                                          Returns string

                                                                                                        • get stackId(): string

                                                                                                          The ID of the stack

                                                                                                          Returns string

                                                                                                          // After resolving, looks like
                                                                                                          'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
                                                                                                          -
                                                                                                        • get notificationArns(): string[]

                                                                                                          Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

                                                                                                          -

                                                                                                          Returns string[]

                                                                                                        • get nested(): boolean

                                                                                                          Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

                                                                                                          -

                                                                                                          Returns boolean

                                                                                                        • get availabilityZones(): string[]

                                                                                                          Returns the list of AZs that are available in the AWS environment +

                                                                                                        • get notificationArns(): string[]

                                                                                                          Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

                                                                                                          +

                                                                                                          Returns string[]

                                                                                                        • get nested(): boolean

                                                                                                          Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

                                                                                                          +

                                                                                                          Returns boolean

                                                                                                        • get availabilityZones(): string[]

                                                                                                          Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

                                                                                                          If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve @@ -140,23 +142,23 @@ reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

                                                                                                          To specify a different strategy for selecting availability zones override this method.

                                                                                                          -

                                                                                                          Returns string[]

                                                                                                        • get nestedStackParent(): undefined | Stack

                                                                                                          If this is a nested stack, returns it's parent stack.

                                                                                                          -

                                                                                                          Returns undefined | Stack

                                                                                                        • get bundlingRequired(): boolean

                                                                                                          Indicates whether the stack requires bundling or not

                                                                                                          -

                                                                                                          Returns boolean

                                                                                                        Methods

                                                                                                        • Return whether the given object is a Stack.

                                                                                                          +

                                                                                                          Returns string[]

                                                                                                        • get nestedStackParent(): undefined | Stack

                                                                                                          If this is a nested stack, returns it's parent stack.

                                                                                                          +

                                                                                                          Returns undefined | Stack

                                                                                                        • get bundlingRequired(): boolean

                                                                                                          Indicates whether the stack requires bundling or not

                                                                                                          +

                                                                                                          Returns boolean

                                                                                                        Methods

                                                                                                        • Return whether the given object is a Stack.

                                                                                                          We do attribute detection since we can't reliably use 'instanceof'.

                                                                                                          -

                                                                                                          Parameters

                                                                                                          • this: void
                                                                                                          • x: any

                                                                                                          Returns x is Stack

                                                                                                        • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

                                                                                                          +

                                                                                                          Parameters

                                                                                                          • this: void
                                                                                                          • x: any

                                                                                                          Returns x is Stack

                                                                                                        • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

                                                                                                          Parameters

                                                                                                          • construct: IConstruct

                                                                                                            The construct to start the search from.

                                                                                                            -

                                                                                                          Returns Stack

                                                                                                        • Resolve a tokenized value in the context of the current stack.

                                                                                                          -

                                                                                                          Parameters

                                                                                                          • obj: any

                                                                                                          Returns any

                                                                                                        • Convert an object, potentially containing tokens, to a JSON string

                                                                                                          -

                                                                                                          Parameters

                                                                                                          • this: void
                                                                                                          • obj: any
                                                                                                          • Optionalspace: number

                                                                                                          Returns string

                                                                                                        • Convert an object, potentially containing tokens, to a YAML string

                                                                                                          -

                                                                                                          Parameters

                                                                                                          • obj: any

                                                                                                          Returns string

                                                                                                        • Indicate that a context key was expected

                                                                                                          +

                                                                                                        Returns Stack

                                                                                                        • Resolve a tokenized value in the context of the current stack.

                                                                                                          +

                                                                                                          Parameters

                                                                                                          • obj: any

                                                                                                          Returns any

                                                                                                        • Convert an object, potentially containing tokens, to a JSON string

                                                                                                          +

                                                                                                          Parameters

                                                                                                          • this: void
                                                                                                          • obj: any
                                                                                                          • Optionalspace: number

                                                                                                          Returns string

                                                                                                        • Convert an object, potentially containing tokens, to a YAML string

                                                                                                          +

                                                                                                          Parameters

                                                                                                          • obj: any

                                                                                                          Returns string

                                                                                                        • Indicate that a context key was expected

                                                                                                          Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

                                                                                                          Parameters

                                                                                                          • report: MissingContext

                                                                                                            The set of parameters needed to obtain the context

                                                                                                            -

                                                                                                          Returns void

                                                                                                        • Rename a generated logical identities

                                                                                                          +

                                                                                                        Returns void

                                                                                                        • Rename a generated logical identities

                                                                                                          To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

                                                                                                          -

                                                                                                          Parameters

                                                                                                          • oldId: string
                                                                                                          • newId: string

                                                                                                          Returns void

                                                                                                        • Allocates a stack-unique CloudFormation-compatible logical identity for a +

                                                                                                          Parameters

                                                                                                          • oldId: string
                                                                                                          • newId: string

                                                                                                          Returns void

                                                                                                        • Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.

                                                                                                          This method is called when a CfnElement is created and used to render the initial logical identity of resources. Logical ID renames are applied at @@ -166,10 +168,10 @@ class and override this method.

                                                                                                          Parameters

                                                                                                          • element: CfnElement

                                                                                                            The CloudFormation element for which a logical identity is needed.

                                                                                                            -

                                                                                                          Returns string

                                                                                                        • Add a dependency between this stack and another stack.

                                                                                                          +

                                                                                                        Returns string

                                                                                                        • Add a dependency between this stack and another stack.

                                                                                                          This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

                                                                                                          -

                                                                                                          Parameters

                                                                                                          • target: Stack
                                                                                                          • Optionalreason: string

                                                                                                          Returns void

                                                                                                        • Creates an ARN from components.

                                                                                                          +

                                                                                                          Parameters

                                                                                                          • target: Stack
                                                                                                          • Optionalreason: string

                                                                                                          Returns void

                                                                                                        • Creates an ARN from components.

                                                                                                          If partition, region or account are not specified, the stack's partition, region and account will be used.

                                                                                                          If any component is the empty string, an empty string will be inserted @@ -179,14 +181,14 @@

                                                                                                          The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'.

                                                                                                          -

                                                                                                          Parameters

                                                                                                          • components: ArnComponents

                                                                                                          Returns string

                                                                                                        • Splits the provided ARN into its components. +

                                                                                                          Parameters

                                                                                                          • components: ArnComponents

                                                                                                          Returns string

                                                                                                        • Splits the provided ARN into its components. Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

                                                                                                          Parameters

                                                                                                          • arn: string

                                                                                                            the ARN to split into its components

                                                                                                          • arnFormat: ArnFormat

                                                                                                            the expected format of 'arn' - depends on what format the service 'arn' represents uses

                                                                                                            -

                                                                                                          Returns ArnComponents

                                                                                                        • Add a Transform to this stack. A Transform is a macro that AWS +

                                                                                                        Returns ArnComponents

                                                                                                        • Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.

                                                                                                          Duplicate values are removed when stack is synthesized.

                                                                                                          Parameters

                                                                                                          • transform: string

                                                                                                            The transform to add

                                                                                                            @@ -194,22 +196,22 @@ 
                                                                                                            declare const stack: Stack;

                                                                                                            stack.addTransform('AWS::Serverless-2016-10-31')
                                                                                                            -

                                                                                                        • Adds an arbitrary key-value pair, with information you want to record about the stack. +

                                                                                                        _addAssemblyDependency

                                                                                                        • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
                                                                                                          Internal

                                                                                                          Called implicitly by the addDependency helper function in order to +

                                                                                                        _addAssemblyDependency

                                                                                                        • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
                                                                                                          Internal

                                                                                                          Called implicitly by the addDependency helper function in order to realize a dependency between two top-level stacks at the assembly level.

                                                                                                          Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

                                                                                                          -

                                                                                                          Parameters

                                                                                                          • target: Stack
                                                                                                          • Optionalreason: StackDependencyReason

                                                                                                          Returns void

                                                                                                        _obtainAssemblyDependencies

                                                                                                        • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
                                                                                                          Internal

                                                                                                          Called implicitly by the obtainDependencies helper function in order to +

                                                                                                          Parameters

                                                                                                          • target: Stack
                                                                                                          • Optionalreason: StackDependencyReason

                                                                                                          Returns void

                                                                                                        _obtainAssemblyDependencies

                                                                                                        • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
                                                                                                          Internal

                                                                                                          Called implicitly by the obtainDependencies helper function in order to collect resource dependencies across two top-level stacks at the assembly level.

                                                                                                          Use stack.obtainDependencies to see the dependencies between any two stacks.

                                                                                                          -

                                                                                                          Parameters

                                                                                                          • reasonFilter: StackDependencyReason

                                                                                                          Returns Element[]

                                                                                                        _removeAssemblyDependency

                                                                                                        • _removeAssemblyDependency(
                                                                                                              target: Stack,
                                                                                                              reasonFilter?: StackDependencyReason,
                                                                                                          ): void
                                                                                                          Internal

                                                                                                          Called implicitly by the removeDependency helper function in order to +

                                                                                                          Parameters

                                                                                                          • reasonFilter: StackDependencyReason

                                                                                                          Returns Element[]

                                                                                                        _removeAssemblyDependency

                                                                                                        • _removeAssemblyDependency(
                                                                                                              target: Stack,
                                                                                                              reasonFilter?: StackDependencyReason,
                                                                                                          ): void
                                                                                                          Internal

                                                                                                          Called implicitly by the removeDependency helper function in order to remove a dependency between two top-level stacks at the assembly level.

                                                                                                          Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

                                                                                                          -

                                                                                                          Parameters

                                                                                                          • target: Stack
                                                                                                          • OptionalreasonFilter: StackDependencyReason

                                                                                                          Returns void

                                                                                                        _synthesizeTemplate

                                                                                                        • _synthesizeTemplate(
                                                                                                              session: ISynthesisSession,
                                                                                                              lookupRoleArn?: string,
                                                                                                              lookupRoleExternalId?: string,
                                                                                                              lookupRoleAdditionalOptions?: { [key: string]: any },
                                                                                                          ): void
                                                                                                          Internal

                                                                                                          Synthesizes the cloudformation template into a cloud assembly.

                                                                                                          -

                                                                                                          Parameters

                                                                                                          • session: ISynthesisSession
                                                                                                          • OptionallookupRoleArn: string
                                                                                                          • OptionallookupRoleExternalId: string
                                                                                                          • OptionallookupRoleAdditionalOptions: { [key: string]: any }

                                                                                                          Returns void

                                                                                                        • Look up a fact value for the given fact for the region of this stack

                                                                                                          +

                                                                                                          Parameters

                                                                                                          • target: Stack
                                                                                                          • OptionalreasonFilter: StackDependencyReason

                                                                                                          Returns void

                                                                                                        _synthesizeTemplate

                                                                                                        • _synthesizeTemplate(
                                                                                                              session: ISynthesisSession,
                                                                                                              lookupRoleArn?: string,
                                                                                                              lookupRoleExternalId?: string,
                                                                                                              lookupRoleAdditionalOptions?: { [key: string]: any },
                                                                                                          ): void
                                                                                                          Internal

                                                                                                          Synthesizes the cloudformation template into a cloud assembly.

                                                                                                          +

                                                                                                          Parameters

                                                                                                          • session: ISynthesisSession
                                                                                                          • OptionallookupRoleArn: string
                                                                                                          • OptionallookupRoleExternalId: string
                                                                                                          • OptionallookupRoleAdditionalOptions: { [key: string]: any }

                                                                                                          Returns void

                                                                                                        • Look up a fact value for the given fact for the region of this stack

                                                                                                          Will return a definite value only if the region of the current stack is resolved. If not, a lookup map will be added to the stack and the lookup will be done at CDK deployment time.

                                                                                                          @@ -222,7 +224,7 @@ not have to worry about regional facts.

                                                                                                          If defaultValue is not given, it is an error if the fact is unknown for the given region.

                                                                                                          -

                                                                                                          Parameters

                                                                                                          • factName: string
                                                                                                          • OptionaldefaultValue: string

                                                                                                          Returns string

                                                                                                        • Create a CloudFormation Export for a string value

                                                                                                          +

                                                                                                          Parameters

                                                                                                          • factName: string
                                                                                                          • OptionaldefaultValue: string

                                                                                                          Returns string

                                                                                                        • Create a CloudFormation Export for a string value

                                                                                                          Returns a string representing the corresponding Fn.importValue() expression for this Export. You can control the name for the export by passing the name option.

                                                                                                          @@ -258,7 +260,7 @@
                                                                                                        • Don't forget to remove the exportValue() call as well.
                                                                                                        • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
                                                                                                        -

                                                                                                        Parameters

                                                                                                        • exportedValue: any
                                                                                                        • Optionaloptions: ExportValueOptions

                                                                                                        Returns string

                                                                                                        • Create a CloudFormation Export for a string list value

                                                                                                          +

                                                                                                          Parameters

                                                                                                          • exportedValue: any
                                                                                                          • Optionaloptions: ExportValueOptions

                                                                                                          Returns string

                                                                                                        • Create a CloudFormation Export for a string list value

                                                                                                          Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only @@ -273,7 +275,7 @@ remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

                                                                                                          See exportValue for an example of this process.

                                                                                                          -

                                                                                                          Parameters

                                                                                                          • exportedValue: any
                                                                                                          • Optionaloptions: ExportValueOptions

                                                                                                          Returns string[]

                                                                                                        • Returns the naming scheme used to allocate logical IDs. By default, uses +

                                                                                                          Parameters

                                                                                                          • exportedValue: any
                                                                                                          • Optionaloptions: ExportValueOptions

                                                                                                          Returns string[]

                                                                                                        • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize this behavior.

                                                                                                          In order to make sure logical IDs are unique and stable, we hash the resource @@ -305,12 +307,16 @@ part of the identifier.

                                                                                                        Parameters

                                                                                                        • cfnElement: CfnElement

                                                                                                          The element for which the logical ID is allocated.

                                                                                                          -

                                                                                                        Returns string

                                                                                                        Protected_validateId

                                                                                                        • _validateId(name: string): void
                                                                                                          Internal

                                                                                                          Validate stack name

                                                                                                          +

                                                                                                        Returns string

                                                                                                        Protected_validateId

                                                                                                        • _validateId(name: string): void
                                                                                                          Internal

                                                                                                          Validate stack name

                                                                                                          CloudFormation stack names can include dashes in addition to the regular identifier character classes, and we don't allow one of the magic markers.

                                                                                                          -

                                                                                                          Parameters

                                                                                                          • name: string

                                                                                                          Returns void

                                                                                                        Protected_toCloudFormation

                                                                                                        • _toCloudFormation(): any
                                                                                                          Internal

                                                                                                          Returns the CloudFormation template for this stack by traversing +

                                                                                                          Parameters

                                                                                                          • name: string

                                                                                                          Returns void

                                                                                                        Protected_toCloudFormation

                                                                                                        • _toCloudFormation(): any
                                                                                                          Internal

                                                                                                          Returns the CloudFormation template for this stack by traversing the tree and invoking _toCloudFormation() on all Entity objects.

                                                                                                          -

                                                                                                          Returns any

                                                                                                        • Checks if x is a construct.

                                                                                                          +

                                                                                                          Returns any

                                                                                                        • Configure a stack tag

                                                                                                          +

                                                                                                          At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.

                                                                                                          +

                                                                                                          Parameters

                                                                                                          • tagName: string
                                                                                                          • tagValue: string

                                                                                                          Returns void

                                                                                                        • Remove a stack tag

                                                                                                          +

                                                                                                          At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.

                                                                                                          +

                                                                                                          Parameters

                                                                                                          • tagName: string

                                                                                                          Returns void

                                                                                                        • Checks if x is a construct.

                                                                                                          Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

                                                                                                          Explanation: in JavaScript, multiple copies of the constructs library on @@ -326,4 +332,4 @@

                                                                                                          Parameters

                                                                                                          • x: any

                                                                                                            Any object

                                                                                                          Returns x is Construct

                                                                                                          true if x is an object created from a class which extends Construct.

                                                                                                        • Returns a string representation of this construct.

                                                                                                          -

                                                                                                          Returns string

                                                                                                        Settings

                                                                                                        Member Visibility

                                                                                                        On This Page

                                                                                                        Constructors
                                                                                                        Properties
                                                                                                        Accessors
                                                                                                        Methods
                                                                                                        +

                                                                                                        Returns string

                                                                                                        Settings

                                                                                                        Member Visibility

                                                                                                        On This Page

                                                                                                        Constructors
                                                                                                        Properties
                                                                                                        Accessors
                                                                                                        Methods
                                                                                                        diff --git a/classes/EmbeddedLinuxCodePipelineStack.html b/classes/EmbeddedLinuxCodePipelineStack.html index b1b4582..1a9ce19 100644 --- a/classes/EmbeddedLinuxCodePipelineStack.html +++ b/classes/EmbeddedLinuxCodePipelineStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodePipelineStack | aws4embeddedlinux-cdk-lib
                                                                                                        aws4embeddedlinux-cdk-lib
                                                                                                          Preparing search index...

                                                                                                          Class EmbeddedLinuxCodePipelineStack

                                                                                                          The stack for creating a build pipeline.

                                                                                                          See EmbeddedLinuxCodePipelineProps for configration options.

                                                                                                          -

                                                                                                          Hierarchy

                                                                                                          • Stack
                                                                                                            • EmbeddedLinuxCodePipelineStack
                                                                                                          Index

                                                                                                          Constructors

                                                                                                          constructor +

                                                                                                          Hierarchy

                                                                                                          • Stack
                                                                                                            • EmbeddedLinuxCodePipelineStack
                                                                                                          Index

                                                                                                          Constructors

                                                                                                          constructor

                                                                                                          Properties

                                                                                                          tags templateOptions region @@ -48,11 +48,13 @@ allocateLogicalId _validateId _toCloudFormation +addStackTag +removeStackTag isConstruct toString -

                                                                                                          Constructors

                                                                                                          Properties

                                                                                                          tags: TagManager

                                                                                                          Tags to be applied to the stack.

                                                                                                          -
                                                                                                          templateOptions: ITemplateOptions

                                                                                                          Options for CloudFormation template (like version, transform, description).

                                                                                                          -
                                                                                                          region: string

                                                                                                          The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                          +

                                                                                                          Constructors

                                                                                                          Properties

                                                                                                          tags: TagManager

                                                                                                          Tags to be applied to the stack.

                                                                                                          +
                                                                                                          templateOptions: ITemplateOptions

                                                                                                          Options for CloudFormation template (like version, transform, description).

                                                                                                          +
                                                                                                          region: string

                                                                                                          The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                          This value is resolved according to the following rules:

                                                                                                          1. The value provided to env.region when the stack is defined. This can @@ -69,7 +71,7 @@ into a region-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

                                                                                                            -
                                                                                                          account: string

                                                                                                          The AWS account into which this stack will be deployed.

                                                                                                          +
                                                                                                          account: string

                                                                                                          The AWS account into which this stack will be deployed.

                                                                                                          This value is resolved according to the following rules:

                                                                                                          1. The value provided to env.account when the stack is defined. This can @@ -86,7 +88,7 @@ into an account-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other account-agnostic behavior.

                                                                                                            -
                                                                                                          environment: string

                                                                                                          The environment coordinates in which this stack is deployed. In the form +

                                                                                                          environment: string

                                                                                                          The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

                                                                                                          You can use this value to determine if two stacks are targeting the same @@ -95,21 +97,21 @@ Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

                                                                                                          -
                                                                                                          nestedStackResource?: CfnResource

                                                                                                          If this is a nested stack, this represents its AWS::CloudFormation::Stack +

                                                                                                          nestedStackResource?: CfnResource

                                                                                                          If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

                                                                                                          -
                                                                                                          templateFile: string

                                                                                                          The name of the CloudFormation template file emitted to the output +

                                                                                                          templateFile: string

                                                                                                          The name of the CloudFormation template file emitted to the output directory during synthesis.

                                                                                                          Example value: MyStack.template.json

                                                                                                          -
                                                                                                          artifactId: string

                                                                                                          The ID of the cloud assembly artifact for this stack.

                                                                                                          -
                                                                                                          synthesizer: IStackSynthesizer

                                                                                                          Synthesis method for this stack

                                                                                                          -

                                                                                                          Readonly Internal_versionReportingEnabled

                                                                                                          _versionReportingEnabled: boolean

                                                                                                          Whether version reporting is enabled for this stack

                                                                                                          +
                                                                                                          artifactId: string

                                                                                                          The ID of the cloud assembly artifact for this stack.

                                                                                                          +
                                                                                                          synthesizer: IStackSynthesizer

                                                                                                          Synthesis method for this stack

                                                                                                          +

                                                                                                          Readonly Internal_versionReportingEnabled

                                                                                                          _versionReportingEnabled: boolean

                                                                                                          Whether version reporting is enabled for this stack

                                                                                                          Controls whether the CDK Metadata resource is injected

                                                                                                          -

                                                                                                          Readonly Internal_crossRegionReferences

                                                                                                          _crossRegionReferences: boolean

                                                                                                          Whether cross region references are enabled for this stack

                                                                                                          -

                                                                                                          Optional Readonly Internal_notificationArns

                                                                                                          _notificationArns?: string[]

                                                                                                          SNS Notification ARNs to receive stack events.

                                                                                                          -
                                                                                                          node: Node

                                                                                                          The tree node.

                                                                                                          +

                                                                                                          Readonly Internal_crossRegionReferences

                                                                                                          _crossRegionReferences: boolean

                                                                                                          Whether cross region references are enabled for this stack

                                                                                                          +

                                                                                                          Optional Readonly Internal_notificationArns

                                                                                                          _notificationArns?: string[]

                                                                                                          SNS Notification ARNs to receive stack events.

                                                                                                          +
                                                                                                          node: Node

                                                                                                          The tree node.

                                                                                                          Accessors

                                                                                                          • get terminationProtection(): boolean

                                                                                                            Whether termination protection is enabled for this stack.

                                                                                                            -

                                                                                                            Returns boolean

                                                                                                          • set terminationProtection(value: boolean): void

                                                                                                            Parameters

                                                                                                            • value: boolean

                                                                                                            Returns void

                                                                                                          • get dependencies(): Stack[]

                                                                                                            Return the stacks this stack depends on

                                                                                                            -

                                                                                                            Returns Stack[]

                                                                                                          • get stackName(): string

                                                                                                            The concrete CloudFormation physical stack name.

                                                                                                            +

                                                                                                            Returns boolean

                                                                                                          • set terminationProtection(value: boolean): void

                                                                                                            Parameters

                                                                                                            • value: boolean

                                                                                                            Returns void

                                                                                                          • get dependencies(): Stack[]

                                                                                                            Return the stacks this stack depends on

                                                                                                            +

                                                                                                            Returns Stack[]

                                                                                                          • get stackName(): string

                                                                                                            The concrete CloudFormation physical stack name.

                                                                                                            This is either the name defined explicitly in the stackName prop or allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack @@ -117,15 +119,15 @@ scheme based on the construct path to ensure uniqueness.

                                                                                                            If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.

                                                                                                            -

                                                                                                            Returns string

                                                                                                          • get partition(): string

                                                                                                            The partition in which this stack is defined

                                                                                                            -

                                                                                                            Returns string

                                                                                                          • get urlSuffix(): string

                                                                                                            The Amazon domain suffix for the region in which this stack is defined

                                                                                                            -

                                                                                                            Returns string

                                                                                                          • get stackId(): string

                                                                                                            The ID of the stack

                                                                                                            +

                                                                                                            Returns string

                                                                                                          • get partition(): string

                                                                                                            The partition in which this stack is defined

                                                                                                            +

                                                                                                            Returns string

                                                                                                          • get urlSuffix(): string

                                                                                                            The Amazon domain suffix for the region in which this stack is defined

                                                                                                            +

                                                                                                            Returns string

                                                                                                          • get stackId(): string

                                                                                                            The ID of the stack

                                                                                                            Returns string

                                                                                                            // After resolving, looks like
                                                                                                            'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
                                                                                                            -
                                                                                                          • get notificationArns(): string[]

                                                                                                            Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

                                                                                                            -

                                                                                                            Returns string[]

                                                                                                          • get nested(): boolean

                                                                                                            Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

                                                                                                            -

                                                                                                            Returns boolean

                                                                                                          • get availabilityZones(): string[]

                                                                                                            Returns the list of AZs that are available in the AWS environment +

                                                                                                          • get notificationArns(): string[]

                                                                                                            Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

                                                                                                            +

                                                                                                            Returns string[]

                                                                                                          • get nested(): boolean

                                                                                                            Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

                                                                                                            +

                                                                                                            Returns boolean

                                                                                                          • get availabilityZones(): string[]

                                                                                                            Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

                                                                                                            If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve @@ -135,23 +137,23 @@ reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

                                                                                                            To specify a different strategy for selecting availability zones override this method.

                                                                                                            -

                                                                                                            Returns string[]

                                                                                                          • get nestedStackParent(): undefined | Stack

                                                                                                            If this is a nested stack, returns it's parent stack.

                                                                                                            -

                                                                                                            Returns undefined | Stack

                                                                                                          • get bundlingRequired(): boolean

                                                                                                            Indicates whether the stack requires bundling or not

                                                                                                            -

                                                                                                            Returns boolean

                                                                                                          Methods

                                                                                                          • Return whether the given object is a Stack.

                                                                                                            +

                                                                                                            Returns string[]

                                                                                                          • get nestedStackParent(): undefined | Stack

                                                                                                            If this is a nested stack, returns it's parent stack.

                                                                                                            +

                                                                                                            Returns undefined | Stack

                                                                                                          • get bundlingRequired(): boolean

                                                                                                            Indicates whether the stack requires bundling or not

                                                                                                            +

                                                                                                            Returns boolean

                                                                                                          Methods

                                                                                                          • Return whether the given object is a Stack.

                                                                                                            We do attribute detection since we can't reliably use 'instanceof'.

                                                                                                            -

                                                                                                            Parameters

                                                                                                            • this: void
                                                                                                            • x: any

                                                                                                            Returns x is Stack

                                                                                                          • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

                                                                                                            +

                                                                                                            Parameters

                                                                                                            • this: void
                                                                                                            • x: any

                                                                                                            Returns x is Stack

                                                                                                          • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

                                                                                                            Parameters

                                                                                                            • construct: IConstruct

                                                                                                              The construct to start the search from.

                                                                                                              -

                                                                                                            Returns Stack

                                                                                                          • Resolve a tokenized value in the context of the current stack.

                                                                                                            -

                                                                                                            Parameters

                                                                                                            • obj: any

                                                                                                            Returns any

                                                                                                          • Convert an object, potentially containing tokens, to a JSON string

                                                                                                            -

                                                                                                            Parameters

                                                                                                            • this: void
                                                                                                            • obj: any
                                                                                                            • Optionalspace: number

                                                                                                            Returns string

                                                                                                          • Convert an object, potentially containing tokens, to a YAML string

                                                                                                            -

                                                                                                            Parameters

                                                                                                            • obj: any

                                                                                                            Returns string

                                                                                                          • Indicate that a context key was expected

                                                                                                            +

                                                                                                          Returns Stack

                                                                                                          • Resolve a tokenized value in the context of the current stack.

                                                                                                            +

                                                                                                            Parameters

                                                                                                            • obj: any

                                                                                                            Returns any

                                                                                                          • Convert an object, potentially containing tokens, to a JSON string

                                                                                                            +

                                                                                                            Parameters

                                                                                                            • this: void
                                                                                                            • obj: any
                                                                                                            • Optionalspace: number

                                                                                                            Returns string

                                                                                                          • Convert an object, potentially containing tokens, to a YAML string

                                                                                                            +

                                                                                                            Parameters

                                                                                                            • obj: any

                                                                                                            Returns string

                                                                                                          • Indicate that a context key was expected

                                                                                                            Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

                                                                                                            Parameters

                                                                                                            • report: MissingContext

                                                                                                              The set of parameters needed to obtain the context

                                                                                                              -

                                                                                                            Returns void

                                                                                                          • Rename a generated logical identities

                                                                                                            +

                                                                                                          Returns void

                                                                                                          • Rename a generated logical identities

                                                                                                            To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

                                                                                                            -

                                                                                                            Parameters

                                                                                                            • oldId: string
                                                                                                            • newId: string

                                                                                                            Returns void

                                                                                                          • Allocates a stack-unique CloudFormation-compatible logical identity for a +

                                                                                                            Parameters

                                                                                                            • oldId: string
                                                                                                            • newId: string

                                                                                                            Returns void

                                                                                                          • Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.

                                                                                                            This method is called when a CfnElement is created and used to render the initial logical identity of resources. Logical ID renames are applied at @@ -161,10 +163,10 @@ class and override this method.

                                                                                                            Parameters

                                                                                                            • element: CfnElement

                                                                                                              The CloudFormation element for which a logical identity is needed.

                                                                                                              -

                                                                                                            Returns string

                                                                                                          • Add a dependency between this stack and another stack.

                                                                                                            +

                                                                                                          Returns string

                                                                                                          • Add a dependency between this stack and another stack.

                                                                                                            This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

                                                                                                            -

                                                                                                            Parameters

                                                                                                            • target: Stack
                                                                                                            • Optionalreason: string

                                                                                                            Returns void

                                                                                                          • Creates an ARN from components.

                                                                                                            +

                                                                                                            Parameters

                                                                                                            • target: Stack
                                                                                                            • Optionalreason: string

                                                                                                            Returns void

                                                                                                          • Creates an ARN from components.

                                                                                                            If partition, region or account are not specified, the stack's partition, region and account will be used.

                                                                                                            If any component is the empty string, an empty string will be inserted @@ -174,14 +176,14 @@

                                                                                                            The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'.

                                                                                                            -

                                                                                                            Parameters

                                                                                                            • components: ArnComponents

                                                                                                            Returns string

                                                                                                          • Splits the provided ARN into its components. +

                                                                                                            Parameters

                                                                                                            • components: ArnComponents

                                                                                                            Returns string

                                                                                                          • Splits the provided ARN into its components. Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

                                                                                                            Parameters

                                                                                                            • arn: string

                                                                                                              the ARN to split into its components

                                                                                                            • arnFormat: ArnFormat

                                                                                                              the expected format of 'arn' - depends on what format the service 'arn' represents uses

                                                                                                              -

                                                                                                            Returns ArnComponents

                                                                                                          • Add a Transform to this stack. A Transform is a macro that AWS +

                                                                                                          Returns ArnComponents

                                                                                                          • Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.

                                                                                                            Duplicate values are removed when stack is synthesized.

                                                                                                            Parameters

                                                                                                            • transform: string

                                                                                                              The transform to add

                                                                                                              @@ -189,22 +191,22 @@ 
                                                                                                              declare const stack: Stack;

                                                                                                              stack.addTransform('AWS::Serverless-2016-10-31')
                                                                                                              -

                                                                                                          • Adds an arbitrary key-value pair, with information you want to record about the stack. +

                                                                                                          _addAssemblyDependency

                                                                                                          • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
                                                                                                            Internal

                                                                                                            Called implicitly by the addDependency helper function in order to +

                                                                                                          _addAssemblyDependency

                                                                                                          • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
                                                                                                            Internal

                                                                                                            Called implicitly by the addDependency helper function in order to realize a dependency between two top-level stacks at the assembly level.

                                                                                                            Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

                                                                                                            -

                                                                                                            Parameters

                                                                                                            • target: Stack
                                                                                                            • Optionalreason: StackDependencyReason

                                                                                                            Returns void

                                                                                                          _obtainAssemblyDependencies

                                                                                                          • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
                                                                                                            Internal

                                                                                                            Called implicitly by the obtainDependencies helper function in order to +

                                                                                                            Parameters

                                                                                                            • target: Stack
                                                                                                            • Optionalreason: StackDependencyReason

                                                                                                            Returns void

                                                                                                          _obtainAssemblyDependencies

                                                                                                          • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
                                                                                                            Internal

                                                                                                            Called implicitly by the obtainDependencies helper function in order to collect resource dependencies across two top-level stacks at the assembly level.

                                                                                                            Use stack.obtainDependencies to see the dependencies between any two stacks.

                                                                                                            -

                                                                                                            Parameters

                                                                                                            • reasonFilter: StackDependencyReason

                                                                                                            Returns Element[]

                                                                                                          _removeAssemblyDependency

                                                                                                          • _removeAssemblyDependency(
                                                                                                                target: Stack,
                                                                                                                reasonFilter?: StackDependencyReason,
                                                                                                            ): void
                                                                                                            Internal

                                                                                                            Called implicitly by the removeDependency helper function in order to +

                                                                                                            Parameters

                                                                                                            • reasonFilter: StackDependencyReason

                                                                                                            Returns Element[]

                                                                                                          _removeAssemblyDependency

                                                                                                          • _removeAssemblyDependency(
                                                                                                                target: Stack,
                                                                                                                reasonFilter?: StackDependencyReason,
                                                                                                            ): void
                                                                                                            Internal

                                                                                                            Called implicitly by the removeDependency helper function in order to remove a dependency between two top-level stacks at the assembly level.

                                                                                                            Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

                                                                                                            -

                                                                                                            Parameters

                                                                                                            • target: Stack
                                                                                                            • OptionalreasonFilter: StackDependencyReason

                                                                                                            Returns void

                                                                                                          _synthesizeTemplate

                                                                                                          • _synthesizeTemplate(
                                                                                                                session: ISynthesisSession,
                                                                                                                lookupRoleArn?: string,
                                                                                                                lookupRoleExternalId?: string,
                                                                                                                lookupRoleAdditionalOptions?: { [key: string]: any },
                                                                                                            ): void
                                                                                                            Internal

                                                                                                            Synthesizes the cloudformation template into a cloud assembly.

                                                                                                            -

                                                                                                            Parameters

                                                                                                            • session: ISynthesisSession
                                                                                                            • OptionallookupRoleArn: string
                                                                                                            • OptionallookupRoleExternalId: string
                                                                                                            • OptionallookupRoleAdditionalOptions: { [key: string]: any }

                                                                                                            Returns void

                                                                                                          • Look up a fact value for the given fact for the region of this stack

                                                                                                            +

                                                                                                            Parameters

                                                                                                            • target: Stack
                                                                                                            • OptionalreasonFilter: StackDependencyReason

                                                                                                            Returns void

                                                                                                          _synthesizeTemplate

                                                                                                          • _synthesizeTemplate(
                                                                                                                session: ISynthesisSession,
                                                                                                                lookupRoleArn?: string,
                                                                                                                lookupRoleExternalId?: string,
                                                                                                                lookupRoleAdditionalOptions?: { [key: string]: any },
                                                                                                            ): void
                                                                                                            Internal

                                                                                                            Synthesizes the cloudformation template into a cloud assembly.

                                                                                                            +

                                                                                                            Parameters

                                                                                                            • session: ISynthesisSession
                                                                                                            • OptionallookupRoleArn: string
                                                                                                            • OptionallookupRoleExternalId: string
                                                                                                            • OptionallookupRoleAdditionalOptions: { [key: string]: any }

                                                                                                            Returns void

                                                                                                          • Look up a fact value for the given fact for the region of this stack

                                                                                                            Will return a definite value only if the region of the current stack is resolved. If not, a lookup map will be added to the stack and the lookup will be done at CDK deployment time.

                                                                                                            @@ -217,7 +219,7 @@ not have to worry about regional facts.

                                                                                                            If defaultValue is not given, it is an error if the fact is unknown for the given region.

                                                                                                            -

                                                                                                            Parameters

                                                                                                            • factName: string
                                                                                                            • OptionaldefaultValue: string

                                                                                                            Returns string

                                                                                                          • Create a CloudFormation Export for a string value

                                                                                                            +

                                                                                                            Parameters

                                                                                                            • factName: string
                                                                                                            • OptionaldefaultValue: string

                                                                                                            Returns string

                                                                                                          • Create a CloudFormation Export for a string value

                                                                                                            Returns a string representing the corresponding Fn.importValue() expression for this Export. You can control the name for the export by passing the name option.

                                                                                                            @@ -253,7 +255,7 @@
                                                                                                          • Don't forget to remove the exportValue() call as well.
                                                                                                          • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
                                                                                                          -

                                                                                                          Parameters

                                                                                                          • exportedValue: any
                                                                                                          • Optionaloptions: ExportValueOptions

                                                                                                          Returns string

                                                                                                          • Create a CloudFormation Export for a string list value

                                                                                                            +

                                                                                                            Parameters

                                                                                                            • exportedValue: any
                                                                                                            • Optionaloptions: ExportValueOptions

                                                                                                            Returns string

                                                                                                          • Create a CloudFormation Export for a string list value

                                                                                                            Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only @@ -268,7 +270,7 @@ remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

                                                                                                            See exportValue for an example of this process.

                                                                                                            -

                                                                                                            Parameters

                                                                                                            • exportedValue: any
                                                                                                            • Optionaloptions: ExportValueOptions

                                                                                                            Returns string[]

                                                                                                          • Returns the naming scheme used to allocate logical IDs. By default, uses +

                                                                                                            Parameters

                                                                                                            • exportedValue: any
                                                                                                            • Optionaloptions: ExportValueOptions

                                                                                                            Returns string[]

                                                                                                          • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize this behavior.

                                                                                                            In order to make sure logical IDs are unique and stable, we hash the resource @@ -300,12 +302,16 @@ part of the identifier.

                                                                                                          Parameters

                                                                                                          • cfnElement: CfnElement

                                                                                                            The element for which the logical ID is allocated.

                                                                                                            -

                                                                                                          Returns string

                                                                                                          Protected_validateId

                                                                                                          • _validateId(name: string): void
                                                                                                            Internal

                                                                                                            Validate stack name

                                                                                                            +

                                                                                                          Returns string

                                                                                                          Protected_validateId

                                                                                                          • _validateId(name: string): void
                                                                                                            Internal

                                                                                                            Validate stack name

                                                                                                            CloudFormation stack names can include dashes in addition to the regular identifier character classes, and we don't allow one of the magic markers.

                                                                                                            -

                                                                                                            Parameters

                                                                                                            • name: string

                                                                                                            Returns void

                                                                                                          Protected_toCloudFormation

                                                                                                          • _toCloudFormation(): any
                                                                                                            Internal

                                                                                                            Returns the CloudFormation template for this stack by traversing +

                                                                                                            Parameters

                                                                                                            • name: string

                                                                                                            Returns void

                                                                                                          Protected_toCloudFormation

                                                                                                          • _toCloudFormation(): any
                                                                                                            Internal

                                                                                                            Returns the CloudFormation template for this stack by traversing the tree and invoking _toCloudFormation() on all Entity objects.

                                                                                                            -

                                                                                                            Returns any

                                                                                                          • Checks if x is a construct.

                                                                                                            +

                                                                                                            Returns any

                                                                                                          • Configure a stack tag

                                                                                                            +

                                                                                                            At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.

                                                                                                            +

                                                                                                            Parameters

                                                                                                            • tagName: string
                                                                                                            • tagValue: string

                                                                                                            Returns void

                                                                                                          • Remove a stack tag

                                                                                                            +

                                                                                                            At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.

                                                                                                            +

                                                                                                            Parameters

                                                                                                            • tagName: string

                                                                                                            Returns void

                                                                                                          • Checks if x is a construct.

                                                                                                            Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

                                                                                                            Explanation: in JavaScript, multiple copies of the constructs library on @@ -321,4 +327,4 @@

                                                                                                            Parameters

                                                                                                            • x: any

                                                                                                              Any object

                                                                                                            Returns x is Construct

                                                                                                            true if x is an object created from a class which extends Construct.

                                                                                                          • Returns a string representation of this construct.

                                                                                                            -

                                                                                                            Returns string

                                                                                                          Settings

                                                                                                          Member Visibility

                                                                                                          On This Page

                                                                                                          Constructors
                                                                                                          Properties
                                                                                                          Accessors
                                                                                                          Methods
                                                                                                          +

                                                                                                          Returns string

                                                                                                          Settings

                                                                                                          Member Visibility

                                                                                                          On This Page

                                                                                                          Constructors
                                                                                                          Properties
                                                                                                          Accessors
                                                                                                          Methods
                                                                                                          diff --git a/classes/PipelineResourcesStack.html b/classes/PipelineResourcesStack.html index 5b72cb8..75cd7a4 100644 --- a/classes/PipelineResourcesStack.html +++ b/classes/PipelineResourcesStack.html @@ -1,5 +1,5 @@ PipelineResourcesStack | aws4embeddedlinux-cdk-lib
                                                                                                          aws4embeddedlinux-cdk-lib
                                                                                                            Preparing search index...

                                                                                                            Class PipelineResourcesStack

                                                                                                            Input (Source) data for our PipelineResourcesStack.

                                                                                                            -

                                                                                                            Hierarchy

                                                                                                            • Stack
                                                                                                              • PipelineResourcesStack
                                                                                                            Index

                                                                                                            Constructors

                                                                                                            constructor +

                                                                                                            Hierarchy

                                                                                                            • Stack
                                                                                                              • PipelineResourcesStack
                                                                                                            Index

                                                                                                            Constructors

                                                                                                            constructor

                                                                                                            Properties

                                                                                                            tags templateOptions region @@ -54,11 +54,13 @@ allocateLogicalId _validateId _toCloudFormation +addStackTag +removeStackTag isConstruct toString -

                                                                                                            Constructors

                                                                                                            Properties

                                                                                                            tags: TagManager

                                                                                                            Tags to be applied to the stack.

                                                                                                            -
                                                                                                            templateOptions: ITemplateOptions

                                                                                                            Options for CloudFormation template (like version, transform, description).

                                                                                                            -
                                                                                                            region: string

                                                                                                            The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                            +

                                                                                                            Constructors

                                                                                                            Properties

                                                                                                            tags: TagManager

                                                                                                            Tags to be applied to the stack.

                                                                                                            +
                                                                                                            templateOptions: ITemplateOptions

                                                                                                            Options for CloudFormation template (like version, transform, description).

                                                                                                            +
                                                                                                            region: string

                                                                                                            The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                            This value is resolved according to the following rules:

                                                                                                            1. The value provided to env.region when the stack is defined. This can @@ -75,7 +77,7 @@ into a region-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

                                                                                                              -
                                                                                                            account: string

                                                                                                            The AWS account into which this stack will be deployed.

                                                                                                            +
                                                                                                            account: string

                                                                                                            The AWS account into which this stack will be deployed.

                                                                                                            This value is resolved according to the following rules:

                                                                                                            1. The value provided to env.account when the stack is defined. This can @@ -92,7 +94,7 @@ into an account-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other account-agnostic behavior.

                                                                                                              -
                                                                                                            environment: string

                                                                                                            The environment coordinates in which this stack is deployed. In the form +

                                                                                                            environment: string

                                                                                                            The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

                                                                                                            You can use this value to determine if two stacks are targeting the same @@ -101,28 +103,28 @@ Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

                                                                                                            -
                                                                                                            nestedStackResource?: CfnResource

                                                                                                            If this is a nested stack, this represents its AWS::CloudFormation::Stack +

                                                                                                            nestedStackResource?: CfnResource

                                                                                                            If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

                                                                                                            -
                                                                                                            templateFile: string

                                                                                                            The name of the CloudFormation template file emitted to the output +

                                                                                                            templateFile: string

                                                                                                            The name of the CloudFormation template file emitted to the output directory during synthesis.

                                                                                                            Example value: MyStack.template.json

                                                                                                            -
                                                                                                            artifactId: string

                                                                                                            The ID of the cloud assembly artifact for this stack.

                                                                                                            -
                                                                                                            synthesizer: IStackSynthesizer

                                                                                                            Synthesis method for this stack

                                                                                                            -

                                                                                                            Readonly Internal_versionReportingEnabled

                                                                                                            _versionReportingEnabled: boolean

                                                                                                            Whether version reporting is enabled for this stack

                                                                                                            +
                                                                                                            artifactId: string

                                                                                                            The ID of the cloud assembly artifact for this stack.

                                                                                                            +
                                                                                                            synthesizer: IStackSynthesizer

                                                                                                            Synthesis method for this stack

                                                                                                            +

                                                                                                            Readonly Internal_versionReportingEnabled

                                                                                                            _versionReportingEnabled: boolean

                                                                                                            Whether version reporting is enabled for this stack

                                                                                                            Controls whether the CDK Metadata resource is injected

                                                                                                            -

                                                                                                            Readonly Internal_crossRegionReferences

                                                                                                            _crossRegionReferences: boolean

                                                                                                            Whether cross region references are enabled for this stack

                                                                                                            -

                                                                                                            Optional Readonly Internal_notificationArns

                                                                                                            _notificationArns?: string[]

                                                                                                            SNS Notification ARNs to receive stack events.

                                                                                                            -
                                                                                                            vpc: IVpc

                                                                                                            The VPC for the pipeline to reside in.

                                                                                                            -
                                                                                                            ecrRepository: IRepository

                                                                                                            The respository to put the build host container in.

                                                                                                            -
                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                            The artifact bucket

                                                                                                            -
                                                                                                            pipelineSourceBucket: Bucket

                                                                                                            The source bucket

                                                                                                            -
                                                                                                            pipelineOutputBucket: Bucket

                                                                                                            The output bucket

                                                                                                            -
                                                                                                            loggingBucket?: Bucket

                                                                                                            The Cloudwatch logging bucket

                                                                                                            -
                                                                                                            encryptionKey: Key

                                                                                                            The encryption key use across

                                                                                                            -
                                                                                                            node: Node

                                                                                                            The tree node.

                                                                                                            +

                                                                                                            Readonly Internal_crossRegionReferences

                                                                                                            _crossRegionReferences: boolean

                                                                                                            Whether cross region references are enabled for this stack

                                                                                                            +

                                                                                                            Optional Readonly Internal_notificationArns

                                                                                                            _notificationArns?: string[]

                                                                                                            SNS Notification ARNs to receive stack events.

                                                                                                            +
                                                                                                            vpc: IVpc

                                                                                                            The VPC for the pipeline to reside in.

                                                                                                            +
                                                                                                            ecrRepository: IRepository

                                                                                                            The respository to put the build host container in.

                                                                                                            +
                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                            The artifact bucket

                                                                                                            +
                                                                                                            pipelineSourceBucket: Bucket

                                                                                                            The source bucket

                                                                                                            +
                                                                                                            pipelineOutputBucket: Bucket

                                                                                                            The output bucket

                                                                                                            +
                                                                                                            loggingBucket?: Bucket

                                                                                                            The Cloudwatch logging bucket

                                                                                                            +
                                                                                                            encryptionKey: Key

                                                                                                            The encryption key use across

                                                                                                            +
                                                                                                            node: Node

                                                                                                            The tree node.

                                                                                                            Accessors

                                                                                                            • get terminationProtection(): boolean

                                                                                                              Whether termination protection is enabled for this stack.

                                                                                                              -

                                                                                                              Returns boolean

                                                                                                            • set terminationProtection(value: boolean): void

                                                                                                              Parameters

                                                                                                              • value: boolean

                                                                                                              Returns void

                                                                                                            • get dependencies(): Stack[]

                                                                                                              Return the stacks this stack depends on

                                                                                                              -

                                                                                                              Returns Stack[]

                                                                                                            • get stackName(): string

                                                                                                              The concrete CloudFormation physical stack name.

                                                                                                              +

                                                                                                              Returns boolean

                                                                                                            • set terminationProtection(value: boolean): void

                                                                                                              Parameters

                                                                                                              • value: boolean

                                                                                                              Returns void

                                                                                                            • get dependencies(): Stack[]

                                                                                                              Return the stacks this stack depends on

                                                                                                              +

                                                                                                              Returns Stack[]

                                                                                                            • get stackName(): string

                                                                                                              The concrete CloudFormation physical stack name.

                                                                                                              This is either the name defined explicitly in the stackName prop or allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack @@ -130,15 +132,15 @@ scheme based on the construct path to ensure uniqueness.

                                                                                                              If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.

                                                                                                              -

                                                                                                              Returns string

                                                                                                            • get partition(): string

                                                                                                              The partition in which this stack is defined

                                                                                                              -

                                                                                                              Returns string

                                                                                                            • get urlSuffix(): string

                                                                                                              The Amazon domain suffix for the region in which this stack is defined

                                                                                                              -

                                                                                                              Returns string

                                                                                                            • get stackId(): string

                                                                                                              The ID of the stack

                                                                                                              +

                                                                                                              Returns string

                                                                                                            • get partition(): string

                                                                                                              The partition in which this stack is defined

                                                                                                              +

                                                                                                              Returns string

                                                                                                            • get urlSuffix(): string

                                                                                                              The Amazon domain suffix for the region in which this stack is defined

                                                                                                              +

                                                                                                              Returns string

                                                                                                            • get stackId(): string

                                                                                                              The ID of the stack

                                                                                                              Returns string

                                                                                                              // After resolving, looks like
                                                                                                              'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
                                                                                                              -
                                                                                                            • get notificationArns(): string[]

                                                                                                              Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

                                                                                                              -

                                                                                                              Returns string[]

                                                                                                            • get nested(): boolean

                                                                                                              Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

                                                                                                              -

                                                                                                              Returns boolean

                                                                                                            • get availabilityZones(): string[]

                                                                                                              Returns the list of AZs that are available in the AWS environment +

                                                                                                            • get notificationArns(): string[]

                                                                                                              Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

                                                                                                              +

                                                                                                              Returns string[]

                                                                                                            • get nested(): boolean

                                                                                                              Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

                                                                                                              +

                                                                                                              Returns boolean

                                                                                                            • get availabilityZones(): string[]

                                                                                                              Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

                                                                                                              If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve @@ -148,23 +150,23 @@ reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

                                                                                                              To specify a different strategy for selecting availability zones override this method.

                                                                                                              -

                                                                                                              Returns string[]

                                                                                                            • get nestedStackParent(): undefined | Stack

                                                                                                              If this is a nested stack, returns it's parent stack.

                                                                                                              -

                                                                                                              Returns undefined | Stack

                                                                                                            • get bundlingRequired(): boolean

                                                                                                              Indicates whether the stack requires bundling or not

                                                                                                              -

                                                                                                              Returns boolean

                                                                                                            Methods

                                                                                                            • Return whether the given object is a Stack.

                                                                                                              +

                                                                                                              Returns string[]

                                                                                                            • get nestedStackParent(): undefined | Stack

                                                                                                              If this is a nested stack, returns it's parent stack.

                                                                                                              +

                                                                                                              Returns undefined | Stack

                                                                                                            • get bundlingRequired(): boolean

                                                                                                              Indicates whether the stack requires bundling or not

                                                                                                              +

                                                                                                              Returns boolean

                                                                                                            Methods

                                                                                                            • Return whether the given object is a Stack.

                                                                                                              We do attribute detection since we can't reliably use 'instanceof'.

                                                                                                              -

                                                                                                              Parameters

                                                                                                              • this: void
                                                                                                              • x: any

                                                                                                              Returns x is Stack

                                                                                                            • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

                                                                                                              +

                                                                                                              Parameters

                                                                                                              • this: void
                                                                                                              • x: any

                                                                                                              Returns x is Stack

                                                                                                            • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

                                                                                                              Parameters

                                                                                                              • construct: IConstruct

                                                                                                                The construct to start the search from.

                                                                                                                -

                                                                                                              Returns Stack

                                                                                                            • Resolve a tokenized value in the context of the current stack.

                                                                                                              -

                                                                                                              Parameters

                                                                                                              • obj: any

                                                                                                              Returns any

                                                                                                            • Convert an object, potentially containing tokens, to a JSON string

                                                                                                              -

                                                                                                              Parameters

                                                                                                              • this: void
                                                                                                              • obj: any
                                                                                                              • Optionalspace: number

                                                                                                              Returns string

                                                                                                            • Convert an object, potentially containing tokens, to a YAML string

                                                                                                              -

                                                                                                              Parameters

                                                                                                              • obj: any

                                                                                                              Returns string

                                                                                                            • Indicate that a context key was expected

                                                                                                              +

                                                                                                            Returns Stack

                                                                                                            • Resolve a tokenized value in the context of the current stack.

                                                                                                              +

                                                                                                              Parameters

                                                                                                              • obj: any

                                                                                                              Returns any

                                                                                                            • Convert an object, potentially containing tokens, to a JSON string

                                                                                                              +

                                                                                                              Parameters

                                                                                                              • this: void
                                                                                                              • obj: any
                                                                                                              • Optionalspace: number

                                                                                                              Returns string

                                                                                                            • Convert an object, potentially containing tokens, to a YAML string

                                                                                                              +

                                                                                                              Parameters

                                                                                                              • obj: any

                                                                                                              Returns string

                                                                                                            • Indicate that a context key was expected

                                                                                                              Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

                                                                                                              Parameters

                                                                                                              • report: MissingContext

                                                                                                                The set of parameters needed to obtain the context

                                                                                                                -

                                                                                                              Returns void

                                                                                                            • Rename a generated logical identities

                                                                                                              +

                                                                                                            Returns void

                                                                                                            • Rename a generated logical identities

                                                                                                              To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

                                                                                                              -

                                                                                                              Parameters

                                                                                                              • oldId: string
                                                                                                              • newId: string

                                                                                                              Returns void

                                                                                                            • Allocates a stack-unique CloudFormation-compatible logical identity for a +

                                                                                                              Parameters

                                                                                                              • oldId: string
                                                                                                              • newId: string

                                                                                                              Returns void

                                                                                                            • Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.

                                                                                                              This method is called when a CfnElement is created and used to render the initial logical identity of resources. Logical ID renames are applied at @@ -174,10 +176,10 @@ class and override this method.

                                                                                                              Parameters

                                                                                                              • element: CfnElement

                                                                                                                The CloudFormation element for which a logical identity is needed.

                                                                                                                -

                                                                                                              Returns string

                                                                                                            • Add a dependency between this stack and another stack.

                                                                                                              +

                                                                                                            Returns string

                                                                                                            • Add a dependency between this stack and another stack.

                                                                                                              This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

                                                                                                              -

                                                                                                              Parameters

                                                                                                              • target: Stack
                                                                                                              • Optionalreason: string

                                                                                                              Returns void

                                                                                                            • Creates an ARN from components.

                                                                                                              +

                                                                                                              Parameters

                                                                                                              • target: Stack
                                                                                                              • Optionalreason: string

                                                                                                              Returns void

                                                                                                            • Creates an ARN from components.

                                                                                                              If partition, region or account are not specified, the stack's partition, region and account will be used.

                                                                                                              If any component is the empty string, an empty string will be inserted @@ -187,14 +189,14 @@

                                                                                                              The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'.

                                                                                                              -

                                                                                                              Parameters

                                                                                                              • components: ArnComponents

                                                                                                              Returns string

                                                                                                            • Splits the provided ARN into its components. +

                                                                                                              Parameters

                                                                                                              • components: ArnComponents

                                                                                                              Returns string

                                                                                                            • Splits the provided ARN into its components. Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

                                                                                                              Parameters

                                                                                                              • arn: string

                                                                                                                the ARN to split into its components

                                                                                                              • arnFormat: ArnFormat

                                                                                                                the expected format of 'arn' - depends on what format the service 'arn' represents uses

                                                                                                                -

                                                                                                              Returns ArnComponents

                                                                                                            • Add a Transform to this stack. A Transform is a macro that AWS +

                                                                                                            Returns ArnComponents

                                                                                                            • Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.

                                                                                                              Duplicate values are removed when stack is synthesized.

                                                                                                              Parameters

                                                                                                              • transform: string

                                                                                                                The transform to add

                                                                                                                @@ -202,22 +204,22 @@ 
                                                                                                                declare const stack: Stack;

                                                                                                                stack.addTransform('AWS::Serverless-2016-10-31')
                                                                                                                -

                                                                                                            • Adds an arbitrary key-value pair, with information you want to record about the stack. +

                                                                                                            _addAssemblyDependency

                                                                                                            • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
                                                                                                              Internal

                                                                                                              Called implicitly by the addDependency helper function in order to +

                                                                                                            _addAssemblyDependency

                                                                                                            • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
                                                                                                              Internal

                                                                                                              Called implicitly by the addDependency helper function in order to realize a dependency between two top-level stacks at the assembly level.

                                                                                                              Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

                                                                                                              -

                                                                                                              Parameters

                                                                                                              • target: Stack
                                                                                                              • Optionalreason: StackDependencyReason

                                                                                                              Returns void

                                                                                                            _obtainAssemblyDependencies

                                                                                                            • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
                                                                                                              Internal

                                                                                                              Called implicitly by the obtainDependencies helper function in order to +

                                                                                                              Parameters

                                                                                                              • target: Stack
                                                                                                              • Optionalreason: StackDependencyReason

                                                                                                              Returns void

                                                                                                            _obtainAssemblyDependencies

                                                                                                            • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
                                                                                                              Internal

                                                                                                              Called implicitly by the obtainDependencies helper function in order to collect resource dependencies across two top-level stacks at the assembly level.

                                                                                                              Use stack.obtainDependencies to see the dependencies between any two stacks.

                                                                                                              -

                                                                                                              Parameters

                                                                                                              • reasonFilter: StackDependencyReason

                                                                                                              Returns Element[]

                                                                                                            _removeAssemblyDependency

                                                                                                            • _removeAssemblyDependency(
                                                                                                                  target: Stack,
                                                                                                                  reasonFilter?: StackDependencyReason,
                                                                                                              ): void
                                                                                                              Internal

                                                                                                              Called implicitly by the removeDependency helper function in order to +

                                                                                                              Parameters

                                                                                                              • reasonFilter: StackDependencyReason

                                                                                                              Returns Element[]

                                                                                                            _removeAssemblyDependency

                                                                                                            • _removeAssemblyDependency(
                                                                                                                  target: Stack,
                                                                                                                  reasonFilter?: StackDependencyReason,
                                                                                                              ): void
                                                                                                              Internal

                                                                                                              Called implicitly by the removeDependency helper function in order to remove a dependency between two top-level stacks at the assembly level.

                                                                                                              Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

                                                                                                              -

                                                                                                              Parameters

                                                                                                              • target: Stack
                                                                                                              • OptionalreasonFilter: StackDependencyReason

                                                                                                              Returns void

                                                                                                            _synthesizeTemplate

                                                                                                            • _synthesizeTemplate(
                                                                                                                  session: ISynthesisSession,
                                                                                                                  lookupRoleArn?: string,
                                                                                                                  lookupRoleExternalId?: string,
                                                                                                                  lookupRoleAdditionalOptions?: { [key: string]: any },
                                                                                                              ): void
                                                                                                              Internal

                                                                                                              Synthesizes the cloudformation template into a cloud assembly.

                                                                                                              -

                                                                                                              Parameters

                                                                                                              • session: ISynthesisSession
                                                                                                              • OptionallookupRoleArn: string
                                                                                                              • OptionallookupRoleExternalId: string
                                                                                                              • OptionallookupRoleAdditionalOptions: { [key: string]: any }

                                                                                                              Returns void

                                                                                                            • Look up a fact value for the given fact for the region of this stack

                                                                                                              +

                                                                                                              Parameters

                                                                                                              • target: Stack
                                                                                                              • OptionalreasonFilter: StackDependencyReason

                                                                                                              Returns void

                                                                                                            _synthesizeTemplate

                                                                                                            • _synthesizeTemplate(
                                                                                                                  session: ISynthesisSession,
                                                                                                                  lookupRoleArn?: string,
                                                                                                                  lookupRoleExternalId?: string,
                                                                                                                  lookupRoleAdditionalOptions?: { [key: string]: any },
                                                                                                              ): void
                                                                                                              Internal

                                                                                                              Synthesizes the cloudformation template into a cloud assembly.

                                                                                                              +

                                                                                                              Parameters

                                                                                                              • session: ISynthesisSession
                                                                                                              • OptionallookupRoleArn: string
                                                                                                              • OptionallookupRoleExternalId: string
                                                                                                              • OptionallookupRoleAdditionalOptions: { [key: string]: any }

                                                                                                              Returns void

                                                                                                            • Look up a fact value for the given fact for the region of this stack

                                                                                                              Will return a definite value only if the region of the current stack is resolved. If not, a lookup map will be added to the stack and the lookup will be done at CDK deployment time.

                                                                                                              @@ -230,7 +232,7 @@ not have to worry about regional facts.

                                                                                                              If defaultValue is not given, it is an error if the fact is unknown for the given region.

                                                                                                              -

                                                                                                              Parameters

                                                                                                              • factName: string
                                                                                                              • OptionaldefaultValue: string

                                                                                                              Returns string

                                                                                                            • Create a CloudFormation Export for a string value

                                                                                                              +

                                                                                                              Parameters

                                                                                                              • factName: string
                                                                                                              • OptionaldefaultValue: string

                                                                                                              Returns string

                                                                                                            • Create a CloudFormation Export for a string value

                                                                                                              Returns a string representing the corresponding Fn.importValue() expression for this Export. You can control the name for the export by passing the name option.

                                                                                                              @@ -266,7 +268,7 @@
                                                                                                            • Don't forget to remove the exportValue() call as well.
                                                                                                            • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
                                                                                                            -

                                                                                                            Parameters

                                                                                                            • exportedValue: any
                                                                                                            • Optionaloptions: ExportValueOptions

                                                                                                            Returns string

                                                                                                            • Create a CloudFormation Export for a string list value

                                                                                                              +

                                                                                                              Parameters

                                                                                                              • exportedValue: any
                                                                                                              • Optionaloptions: ExportValueOptions

                                                                                                              Returns string

                                                                                                            • Create a CloudFormation Export for a string list value

                                                                                                              Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only @@ -281,7 +283,7 @@ remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

                                                                                                              See exportValue for an example of this process.

                                                                                                              -

                                                                                                              Parameters

                                                                                                              • exportedValue: any
                                                                                                              • Optionaloptions: ExportValueOptions

                                                                                                              Returns string[]

                                                                                                            • Returns the naming scheme used to allocate logical IDs. By default, uses +

                                                                                                              Parameters

                                                                                                              • exportedValue: any
                                                                                                              • Optionaloptions: ExportValueOptions

                                                                                                              Returns string[]

                                                                                                            • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize this behavior.

                                                                                                              In order to make sure logical IDs are unique and stable, we hash the resource @@ -313,12 +315,16 @@ part of the identifier.

                                                                                                            Parameters

                                                                                                            • cfnElement: CfnElement

                                                                                                              The element for which the logical ID is allocated.

                                                                                                              -

                                                                                                            Returns string

                                                                                                            Protected_validateId

                                                                                                            • _validateId(name: string): void
                                                                                                              Internal

                                                                                                              Validate stack name

                                                                                                              +

                                                                                                            Returns string

                                                                                                            Protected_validateId

                                                                                                            • _validateId(name: string): void
                                                                                                              Internal

                                                                                                              Validate stack name

                                                                                                              CloudFormation stack names can include dashes in addition to the regular identifier character classes, and we don't allow one of the magic markers.

                                                                                                              -

                                                                                                              Parameters

                                                                                                              • name: string

                                                                                                              Returns void

                                                                                                            Protected_toCloudFormation

                                                                                                            • _toCloudFormation(): any
                                                                                                              Internal

                                                                                                              Returns the CloudFormation template for this stack by traversing +

                                                                                                              Parameters

                                                                                                              • name: string

                                                                                                              Returns void

                                                                                                            Protected_toCloudFormation

                                                                                                            • _toCloudFormation(): any
                                                                                                              Internal

                                                                                                              Returns the CloudFormation template for this stack by traversing the tree and invoking _toCloudFormation() on all Entity objects.

                                                                                                              -

                                                                                                              Returns any

                                                                                                            • Checks if x is a construct.

                                                                                                              +

                                                                                                              Returns any

                                                                                                            • Configure a stack tag

                                                                                                              +

                                                                                                              At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.

                                                                                                              +

                                                                                                              Parameters

                                                                                                              • tagName: string
                                                                                                              • tagValue: string

                                                                                                              Returns void

                                                                                                            • Remove a stack tag

                                                                                                              +

                                                                                                              At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.

                                                                                                              +

                                                                                                              Parameters

                                                                                                              • tagName: string

                                                                                                              Returns void

                                                                                                            • Checks if x is a construct.

                                                                                                              Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

                                                                                                              Explanation: in JavaScript, multiple copies of the constructs library on @@ -334,4 +340,4 @@

                                                                                                              Parameters

                                                                                                              • x: any

                                                                                                                Any object

                                                                                                              Returns x is Construct

                                                                                                              true if x is an object created from a class which extends Construct.

                                                                                                            • Returns a string representation of this construct.

                                                                                                              -

                                                                                                              Returns string

                                                                                                            Settings

                                                                                                            Member Visibility

                                                                                                            On This Page

                                                                                                            Constructors
                                                                                                            Properties
                                                                                                            Accessors
                                                                                                            Methods
                                                                                                            +

                                                                                                            Returns string

                                                                                                            Settings

                                                                                                            Member Visibility

                                                                                                            On This Page

                                                                                                            Constructors
                                                                                                            Properties
                                                                                                            Accessors
                                                                                                            Methods
                                                                                                            diff --git a/enums/ProjectType.html b/enums/ProjectType.html index b2c2d76..e3c7bd1 100644 --- a/enums/ProjectType.html +++ b/enums/ProjectType.html @@ -1,5 +1,5 @@ ProjectType | aws4embeddedlinux-cdk-lib
                                                                                                            aws4embeddedlinux-cdk-lib
                                                                                                              Preparing search index...

                                                                                                              Enumeration ProjectType

                                                                                                              The type of project built.

                                                                                                              -
                                                                                                              Index

                                                                                                              Enumeration Members

                                                                                                              Poky +
                                                                                                              Index

                                                                                                              Enumeration Members

                                                                                                              Poky QEmu PokyAmi Kas @@ -8,11 +8,11 @@ CodeBuild Custom

                                                                                                              Enumeration Members

                                                                                                              Poky: "poky"

                                                                                                              Build core-image-minimal from poky.

                                                                                                              -
                                                                                                              QEmu: "qemu"

                                                                                                              Build the Qemu meta-aws Demonstration Distribution.

                                                                                                              -
                                                                                                              PokyAmi: "poky-ami"

                                                                                                              Build an EC2 AMI

                                                                                                              -
                                                                                                              Kas: "kas"

                                                                                                              Build an kas based image

                                                                                                              -
                                                                                                              Renesas: "renesas"

                                                                                                              Build an Renesas image

                                                                                                              -
                                                                                                              NxpImx: "nxp-imx"

                                                                                                              Build an IMX image using NXP layers.

                                                                                                              -
                                                                                                              CodeBuild: "codebuild"

                                                                                                              Build no pipeline, just CodeBuild project to connect with GitHub actions.

                                                                                                              -
                                                                                                              Custom: "custom"

                                                                                                              Build an image using a custom buildspec and asstes.

                                                                                                              -

                                                                                                              Settings

                                                                                                              Member Visibility

                                                                                                              On This Page

                                                                                                              Enumeration Members
                                                                                                              +
                                                                                                              QEmu: "qemu"

                                                                                                              Build the Qemu meta-aws Demonstration Distribution.

                                                                                                              +
                                                                                                              PokyAmi: "poky-ami"

                                                                                                              Build an EC2 AMI

                                                                                                              +
                                                                                                              Kas: "kas"

                                                                                                              Build an kas based image

                                                                                                              +
                                                                                                              Renesas: "renesas"

                                                                                                              Build an Renesas image

                                                                                                              +
                                                                                                              NxpImx: "nxp-imx"

                                                                                                              Build an IMX image using NXP layers.

                                                                                                              +
                                                                                                              CodeBuild: "codebuild"

                                                                                                              Build no pipeline, just CodeBuild project to connect with GitHub actions.

                                                                                                              +
                                                                                                              Custom: "custom"

                                                                                                              Build an image using a custom buildspec and asstes.

                                                                                                              +

                                                                                                              Settings

                                                                                                              Member Visibility

                                                                                                              On This Page

                                                                                                              Enumeration Members
                                                                                                              diff --git a/interfaces/EmbeddedLinuxCodeBuildProjectProps.html b/interfaces/EmbeddedLinuxCodeBuildProjectProps.html index 042120b..3192ade 100644 --- a/interfaces/EmbeddedLinuxCodeBuildProjectProps.html +++ b/interfaces/EmbeddedLinuxCodeBuildProjectProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodeBuildProjectProps | aws4embeddedlinux-cdk-lib
                                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                                Preparing search index...

                                                                                                                Interface EmbeddedLinuxCodeBuildProjectProps

                                                                                                                Properties to allow customizing the build.

                                                                                                                -
                                                                                                                interface EmbeddedLinuxCodeBuildProjectProps {
                                                                                                                    description?: string;
                                                                                                                    env?: Environment;
                                                                                                                    stackName?: string;
                                                                                                                    tags?: { [key: string]: string };
                                                                                                                    notificationArns?: string[];
                                                                                                                    synthesizer?: IStackSynthesizer;
                                                                                                                    terminationProtection?: boolean;
                                                                                                                    analyticsReporting?: boolean;
                                                                                                                    crossRegionReferences?: boolean;
                                                                                                                    permissionsBoundary?: PermissionsBoundary;
                                                                                                                    suppressTemplateIndentation?: boolean;
                                                                                                                    ecrRepository: IRepository;
                                                                                                                    ecrRepositoryImageTag: string;
                                                                                                                    vpc: IVpc;
                                                                                                                    buildPolicyAdditions?: PolicyStatement[];
                                                                                                                    encryptionKey: Key;
                                                                                                                }

                                                                                                                Hierarchy

                                                                                                                • StackProps
                                                                                                                  • EmbeddedLinuxCodeBuildProjectProps
                                                                                                                Index

                                                                                                                Properties

                                                                                                                description? +
                                                                                                                interface EmbeddedLinuxCodeBuildProjectProps {
                                                                                                                    description?: string;
                                                                                                                    env?: Environment;
                                                                                                                    stackName?: string;
                                                                                                                    tags?: { [key: string]: string };
                                                                                                                    notificationArns?: string[];
                                                                                                                    synthesizer?: IStackSynthesizer;
                                                                                                                    terminationProtection?: boolean;
                                                                                                                    analyticsReporting?: boolean;
                                                                                                                    crossRegionReferences?: boolean;
                                                                                                                    permissionsBoundary?: PermissionsBoundary;
                                                                                                                    suppressTemplateIndentation?: boolean;
                                                                                                                    propertyInjectors?: IPropertyInjector[];
                                                                                                                    ecrRepository: IRepository;
                                                                                                                    ecrRepositoryImageTag: string;
                                                                                                                    vpc: IVpc;
                                                                                                                    buildPolicyAdditions?: PolicyStatement[];
                                                                                                                    encryptionKey: Key;
                                                                                                                }

                                                                                                                Hierarchy

                                                                                                                • StackProps
                                                                                                                  • EmbeddedLinuxCodeBuildProjectProps
                                                                                                                Index

                                                                                                                Properties

                                                                                                                description? env? stackName? tags? @@ -10,6 +10,7 @@ crossRegionReferences? permissionsBoundary? suppressTemplateIndentation? +propertyInjectors? ecrRepository ecrRepositoryImageTag vpc @@ -19,7 +20,7 @@ 
                                                                                                                - No description.
                                                                                                                -
                                                                                                                env?: Environment

                                                                                                                The AWS environment (account/region) where this stack will be deployed.

                                                                                                                +
                                                                                                                env?: Environment

                                                                                                                The AWS environment (account/region) where this stack will be deployed.

                                                                                                                Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables @@ -43,19 +44,25 @@

                                                                                                              • The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
                                                                                                                • -
                                                                                                                stackName?: string

                                                                                                                Name to deploy the stack with

                                                                                                                +
                                                                                                                stackName?: string

                                                                                                                Name to deploy the stack with

                                                                                                                - Derived from construct path.
                                                                                                                -
                                                                                                                tags?: { [key: string]: string }

                                                                                                                Stack tags that will be applied to all the taggable resources and the stack itself.

                                                                                                                +
                                                                                                                tags?: { [key: string]: string }

                                                                                                                Tags that will be applied to the Stack

                                                                                                                +

                                                                                                                These tags are applied to the CloudFormation Stack itself. They will not +appear in the CloudFormation template.

                                                                                                                +

                                                                                                                However, at deployment time, CloudFormation will apply these tags to all +resources in the stack that support tagging. You will not be able to exempt +resources from tagging (using the excludeResourceTypes property of +Tags.of(...).add()) for tags applied in this way.

                                                                                                                {}
                                                                                                                -
                                                                                                                notificationArns?: string[]

                                                                                                                SNS Topic ARNs that will receive stack events.

                                                                                                                +
                                                                                                                notificationArns?: string[]

                                                                                                                SNS Topic ARNs that will receive stack events.

                                                                                                                - no notfication arns.
                                                                                                                -
                                                                                                                synthesizer?: IStackSynthesizer

                                                                                                                Synthesis method to use while deploying this stack

                                                                                                                +
                                                                                                                synthesizer?: IStackSynthesizer

                                                                                                                Synthesis method to use while deploying this stack

                                                                                                                The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

                                                                                                                @@ -67,26 +74,26 @@
                                                                                                                • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
                                                                                                                -
                                                                                                                terminationProtection?: boolean

                                                                                                                Whether to enable termination protection for this stack.

                                                                                                                +
                                                                                                                terminationProtection?: boolean

                                                                                                                Whether to enable termination protection for this stack.

                                                                                                                false
                                                                                                                -
                                                                                                                analyticsReporting?: boolean

                                                                                                                Include runtime versioning information in this Stack

                                                                                                                +
                                                                                                                analyticsReporting?: boolean

                                                                                                                Include runtime versioning information in this Stack

                                                                                                                analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key

                                                                                                                -
                                                                                                                crossRegionReferences?: boolean

                                                                                                                Enable this flag to allow native cross region stack references.

                                                                                                                +
                                                                                                                crossRegionReferences?: boolean

                                                                                                                Enable this flag to allow native cross region stack references.

                                                                                                                Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

                                                                                                                This feature is currently experimental

                                                                                                                false
                                                                                                                -
                                                                                                                permissionsBoundary?: PermissionsBoundary

                                                                                                                Options for applying a permissions boundary to all IAM Roles +

                                                                                                                permissionsBoundary?: PermissionsBoundary

                                                                                                                Options for applying a permissions boundary to all IAM Roles and Users created within this Stage

                                                                                                                - no permissions boundary is applied
                                                                                                                -
                                                                                                                suppressTemplateIndentation?: boolean

                                                                                                                Enable this flag to suppress indentation in generated +

                                                                                                                suppressTemplateIndentation?: boolean

                                                                                                                Enable this flag to suppress indentation in generated CloudFormation templates.

                                                                                                                If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the @@ -94,9 +101,13 @@

                                                                                                                • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                                                                                                -
                                                                                                                ecrRepository: IRepository

                                                                                                                ECR Repository where the Build Host Image resides.

                                                                                                                -
                                                                                                                ecrRepositoryImageTag: string

                                                                                                                Tag for the Build Host Image

                                                                                                                -
                                                                                                                vpc: IVpc

                                                                                                                VPC where the networking setup resides.

                                                                                                                -
                                                                                                                buildPolicyAdditions?: PolicyStatement[]

                                                                                                                Additional policy statements to add to the build project.

                                                                                                                -
                                                                                                                encryptionKey: Key

                                                                                                                The encryption key use across

                                                                                                                -

                                                                                                                Settings

                                                                                                                Member Visibility

                                                                                                                On This Page

                                                                                                                Properties
                                                                                                                +
                                                                                                                propertyInjectors?: IPropertyInjector[]

                                                                                                                A list of IPropertyInjector attached to this Stack.

                                                                                                                +
                                                                                                                - no PropertyInjectors
+
                                                                                                                + +
                                                                                                                ecrRepository: IRepository

                                                                                                                ECR Repository where the Build Host Image resides.

                                                                                                                +
                                                                                                                ecrRepositoryImageTag: string

                                                                                                                Tag for the Build Host Image

                                                                                                                +
                                                                                                                vpc: IVpc

                                                                                                                VPC where the networking setup resides.

                                                                                                                +
                                                                                                                buildPolicyAdditions?: PolicyStatement[]

                                                                                                                Additional policy statements to add to the build project.

                                                                                                                +
                                                                                                                encryptionKey: Key

                                                                                                                The encryption key use across

                                                                                                                +

                                                                                                                Settings

                                                                                                                Member Visibility

                                                                                                                On This Page

                                                                                                                Properties
                                                                                                                diff --git a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html index a8e559a..9684c69 100644 --- a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineBaseImageProps | aws4embeddedlinux-cdk-lib
                                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                                  Preparing search index...

                                                                                                                  Interface EmbeddedLinuxCodePipelineBaseImageProps

                                                                                                                  Select options for the BuildImageCodePipelineStack.

                                                                                                                  -
                                                                                                                  interface EmbeddedLinuxCodePipelineBaseImageProps {
                                                                                                                      description?: string;
                                                                                                                      env?: Environment;
                                                                                                                      stackName?: string;
                                                                                                                      tags?: { [key: string]: string };
                                                                                                                      notificationArns?: string[];
                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                      terminationProtection?: boolean;
                                                                                                                      analyticsReporting?: boolean;
                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                      pipelineSourceBucket: IBucket;
                                                                                                                      pipelineSourcePrefix?: string;
                                                                                                                      pipelineArtifactBucket: Bucket;
                                                                                                                      ecrRepository: IRepository;
                                                                                                                      encryptionKey: Key;
                                                                                                                  }

                                                                                                                  Hierarchy

                                                                                                                  • StackProps
                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageProps
                                                                                                                  Index

                                                                                                                  Properties

                                                                                                                  description? +
                                                                                                                  interface EmbeddedLinuxCodePipelineBaseImageProps {
                                                                                                                      description?: string;
                                                                                                                      env?: Environment;
                                                                                                                      stackName?: string;
                                                                                                                      tags?: { [key: string]: string };
                                                                                                                      notificationArns?: string[];
                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                      terminationProtection?: boolean;
                                                                                                                      analyticsReporting?: boolean;
                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                      propertyInjectors?: IPropertyInjector[];
                                                                                                                      pipelineSourceBucket: IBucket;
                                                                                                                      pipelineSourcePrefix?: string;
                                                                                                                      pipelineArtifactBucket: Bucket;
                                                                                                                      ecrRepository: IRepository;
                                                                                                                      encryptionKey: Key;
                                                                                                                  }

                                                                                                                  Hierarchy

                                                                                                                  • StackProps
                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageProps
                                                                                                                  Index

                                                                                                                  Properties

                                                                                                                  description? env? stackName? tags? @@ -10,6 +10,7 @@ crossRegionReferences? permissionsBoundary? suppressTemplateIndentation? +propertyInjectors? pipelineSourceBucket pipelineSourcePrefix? pipelineArtifactBucket @@ -19,7 +20,7 @@ 
                                                                                                                  - No description.
                                                                                                                  -
                                                                                                                  env?: Environment

                                                                                                                  The AWS environment (account/region) where this stack will be deployed.

                                                                                                                  +
                                                                                                                  env?: Environment

                                                                                                                  The AWS environment (account/region) where this stack will be deployed.

                                                                                                                  Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables @@ -43,19 +44,25 @@

                                                                                                                • The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
                                                                                                                  • -
                                                                                                                  stackName?: string

                                                                                                                  Name to deploy the stack with

                                                                                                                  +
                                                                                                                  stackName?: string

                                                                                                                  Name to deploy the stack with

                                                                                                                  - Derived from construct path.
                                                                                                                  -
                                                                                                                  tags?: { [key: string]: string }

                                                                                                                  Stack tags that will be applied to all the taggable resources and the stack itself.

                                                                                                                  +
                                                                                                                  tags?: { [key: string]: string }

                                                                                                                  Tags that will be applied to the Stack

                                                                                                                  +

                                                                                                                  These tags are applied to the CloudFormation Stack itself. They will not +appear in the CloudFormation template.

                                                                                                                  +

                                                                                                                  However, at deployment time, CloudFormation will apply these tags to all +resources in the stack that support tagging. You will not be able to exempt +resources from tagging (using the excludeResourceTypes property of +Tags.of(...).add()) for tags applied in this way.

                                                                                                                  {}
                                                                                                                  -
                                                                                                                  notificationArns?: string[]

                                                                                                                  SNS Topic ARNs that will receive stack events.

                                                                                                                  +
                                                                                                                  notificationArns?: string[]

                                                                                                                  SNS Topic ARNs that will receive stack events.

                                                                                                                  - no notfication arns.
                                                                                                                  -
                                                                                                                  synthesizer?: IStackSynthesizer

                                                                                                                  Synthesis method to use while deploying this stack

                                                                                                                  +
                                                                                                                  synthesizer?: IStackSynthesizer

                                                                                                                  Synthesis method to use while deploying this stack

                                                                                                                  The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

                                                                                                                  @@ -67,26 +74,26 @@
                                                                                                                  • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
                                                                                                                  -
                                                                                                                  terminationProtection?: boolean

                                                                                                                  Whether to enable termination protection for this stack.

                                                                                                                  +
                                                                                                                  terminationProtection?: boolean

                                                                                                                  Whether to enable termination protection for this stack.

                                                                                                                  false
                                                                                                                  -
                                                                                                                  analyticsReporting?: boolean

                                                                                                                  Include runtime versioning information in this Stack

                                                                                                                  +
                                                                                                                  analyticsReporting?: boolean

                                                                                                                  Include runtime versioning information in this Stack

                                                                                                                  analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key

                                                                                                                  -
                                                                                                                  crossRegionReferences?: boolean

                                                                                                                  Enable this flag to allow native cross region stack references.

                                                                                                                  +
                                                                                                                  crossRegionReferences?: boolean

                                                                                                                  Enable this flag to allow native cross region stack references.

                                                                                                                  Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

                                                                                                                  This feature is currently experimental

                                                                                                                  false
                                                                                                                  -
                                                                                                                  permissionsBoundary?: PermissionsBoundary

                                                                                                                  Options for applying a permissions boundary to all IAM Roles +

                                                                                                                  permissionsBoundary?: PermissionsBoundary

                                                                                                                  Options for applying a permissions boundary to all IAM Roles and Users created within this Stage

                                                                                                                  - no permissions boundary is applied
                                                                                                                  -
                                                                                                                  suppressTemplateIndentation?: boolean

                                                                                                                  Enable this flag to suppress indentation in generated +

                                                                                                                  suppressTemplateIndentation?: boolean

                                                                                                                  Enable this flag to suppress indentation in generated CloudFormation templates.

                                                                                                                  If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the @@ -94,9 +101,13 @@

                                                                                                                  • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                                                                                                  -
                                                                                                                  pipelineSourceBucket: IBucket

                                                                                                                  The pipeline source bucket

                                                                                                                  -
                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                  The pipeline source prefix

                                                                                                                  -
                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                  Artifact bucket to use

                                                                                                                  -
                                                                                                                  ecrRepository: IRepository

                                                                                                                  The ECR Repository to push to.

                                                                                                                  -
                                                                                                                  encryptionKey: Key

                                                                                                                  The encryption key use across

                                                                                                                  -

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  On This Page

                                                                                                                  Properties
                                                                                                                  +
                                                                                                                  propertyInjectors?: IPropertyInjector[]

                                                                                                                  A list of IPropertyInjector attached to this Stack.

                                                                                                                  +
                                                                                                                  - no PropertyInjectors
+
                                                                                                                  + +
                                                                                                                  pipelineSourceBucket: IBucket

                                                                                                                  The pipeline source bucket

                                                                                                                  +
                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                  The pipeline source prefix

                                                                                                                  +
                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                  Artifact bucket to use

                                                                                                                  +
                                                                                                                  ecrRepository: IRepository

                                                                                                                  The ECR Repository to push to.

                                                                                                                  +
                                                                                                                  encryptionKey: Key

                                                                                                                  The encryption key use across

                                                                                                                  +

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  On This Page

                                                                                                                  Properties
                                                                                                                  diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index c6d72d1..38cb2f2 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                                    Preparing search index...

                                                                                                                    Interface EmbeddedLinuxCodePipelineProps

                                                                                                                    Properties to allow customizing the build.

                                                                                                                    -
                                                                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                                                                        description?: string;
                                                                                                                        env?: Environment;
                                                                                                                        stackName?: string;
                                                                                                                        tags?: { [key: string]: string };
                                                                                                                        notificationArns?: string[];
                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                        terminationProtection?: boolean;
                                                                                                                        analyticsReporting?: boolean;
                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                        pipelineSourceBucket: IBucket;
                                                                                                                        pipelineSourcePrefix?: string;
                                                                                                                        pipelineArtifactBucket: Bucket;
                                                                                                                        pipelineArtifactPrefix?: string;
                                                                                                                        pipelineOutputBucket: Bucket;
                                                                                                                        pipelineOutputPrefix?: string;
                                                                                                                        ecrRepository: IRepository;
                                                                                                                        ecrRepositoryImageTag: string;
                                                                                                                        projectType: ProjectType;
                                                                                                                        vpc: IVpc;
                                                                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                        encryptionKey: Key;
                                                                                                                        sourceCustomPath?: string;
                                                                                                                    }

                                                                                                                    Hierarchy

                                                                                                                    • StackProps
                                                                                                                      • EmbeddedLinuxCodePipelineProps
                                                                                                                    Index

                                                                                                                    Properties

                                                                                                                    description? +
                                                                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                                                                        description?: string;
                                                                                                                        env?: Environment;
                                                                                                                        stackName?: string;
                                                                                                                        tags?: { [key: string]: string };
                                                                                                                        notificationArns?: string[];
                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                        terminationProtection?: boolean;
                                                                                                                        analyticsReporting?: boolean;
                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                        pipelineSourceBucket: IBucket;
                                                                                                                        pipelineSourcePrefix?: string;
                                                                                                                        pipelineArtifactBucket: Bucket;
                                                                                                                        pipelineArtifactPrefix?: string;
                                                                                                                        pipelineOutputBucket: Bucket;
                                                                                                                        pipelineOutputPrefix?: string;
                                                                                                                        ecrRepository: IRepository;
                                                                                                                        ecrRepositoryImageTag: string;
                                                                                                                        projectType: ProjectType;
                                                                                                                        vpc: IVpc;
                                                                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                        encryptionKey: Key;
                                                                                                                        sourceCustomPath?: string;
                                                                                                                    }

                                                                                                                    Hierarchy

                                                                                                                    • StackProps
                                                                                                                      • EmbeddedLinuxCodePipelineProps
                                                                                                                    Index

                                                                                                                    Properties

                                                                                                                    description? env? stackName? tags? @@ -10,6 +10,7 @@ crossRegionReferences? permissionsBoundary? suppressTemplateIndentation? +propertyInjectors? pipelineSourceBucket pipelineSourcePrefix? pipelineArtifactBucket @@ -28,7 +29,7 @@ 
                                                                                                                    - No description.
                                                                                                                    -
                                                                                                                    env?: Environment

                                                                                                                    The AWS environment (account/region) where this stack will be deployed.

                                                                                                                    +
                                                                                                                    env?: Environment

                                                                                                                    The AWS environment (account/region) where this stack will be deployed.

                                                                                                                    Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables @@ -52,19 +53,25 @@

                                                                                                                  • The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
                                                                                                                    • -
                                                                                                                    stackName?: string

                                                                                                                    Name to deploy the stack with

                                                                                                                    +
                                                                                                                    stackName?: string

                                                                                                                    Name to deploy the stack with

                                                                                                                    - Derived from construct path.
                                                                                                                    -
                                                                                                                    tags?: { [key: string]: string }

                                                                                                                    Stack tags that will be applied to all the taggable resources and the stack itself.

                                                                                                                    +
                                                                                                                    tags?: { [key: string]: string }

                                                                                                                    Tags that will be applied to the Stack

                                                                                                                    +

                                                                                                                    These tags are applied to the CloudFormation Stack itself. They will not +appear in the CloudFormation template.

                                                                                                                    +

                                                                                                                    However, at deployment time, CloudFormation will apply these tags to all +resources in the stack that support tagging. You will not be able to exempt +resources from tagging (using the excludeResourceTypes property of +Tags.of(...).add()) for tags applied in this way.

                                                                                                                    {}
                                                                                                                    -
                                                                                                                    notificationArns?: string[]

                                                                                                                    SNS Topic ARNs that will receive stack events.

                                                                                                                    +
                                                                                                                    notificationArns?: string[]

                                                                                                                    SNS Topic ARNs that will receive stack events.

                                                                                                                    - no notfication arns.
                                                                                                                    -
                                                                                                                    synthesizer?: IStackSynthesizer

                                                                                                                    Synthesis method to use while deploying this stack

                                                                                                                    +
                                                                                                                    synthesizer?: IStackSynthesizer

                                                                                                                    Synthesis method to use while deploying this stack

                                                                                                                    The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

                                                                                                                    @@ -76,26 +83,26 @@
                                                                                                                    • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
                                                                                                                    -
                                                                                                                    terminationProtection?: boolean

                                                                                                                    Whether to enable termination protection for this stack.

                                                                                                                    +
                                                                                                                    terminationProtection?: boolean

                                                                                                                    Whether to enable termination protection for this stack.

                                                                                                                    false
                                                                                                                    -
                                                                                                                    analyticsReporting?: boolean

                                                                                                                    Include runtime versioning information in this Stack

                                                                                                                    +
                                                                                                                    analyticsReporting?: boolean

                                                                                                                    Include runtime versioning information in this Stack

                                                                                                                    analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key

                                                                                                                    -
                                                                                                                    crossRegionReferences?: boolean

                                                                                                                    Enable this flag to allow native cross region stack references.

                                                                                                                    +
                                                                                                                    crossRegionReferences?: boolean

                                                                                                                    Enable this flag to allow native cross region stack references.

                                                                                                                    Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

                                                                                                                    This feature is currently experimental

                                                                                                                    false
                                                                                                                    -
                                                                                                                    permissionsBoundary?: PermissionsBoundary

                                                                                                                    Options for applying a permissions boundary to all IAM Roles +

                                                                                                                    permissionsBoundary?: PermissionsBoundary

                                                                                                                    Options for applying a permissions boundary to all IAM Roles and Users created within this Stage

                                                                                                                    - no permissions boundary is applied
                                                                                                                    -
                                                                                                                    suppressTemplateIndentation?: boolean

                                                                                                                    Enable this flag to suppress indentation in generated +

                                                                                                                    suppressTemplateIndentation?: boolean

                                                                                                                    Enable this flag to suppress indentation in generated CloudFormation templates.

                                                                                                                    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the @@ -103,18 +110,22 @@

                                                                                                                    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                                                                                                    -
                                                                                                                    pipelineSourceBucket: IBucket

                                                                                                                    The pipeline source bucket

                                                                                                                    -
                                                                                                                    pipelineSourcePrefix?: string

                                                                                                                    The pipeline source prefix

                                                                                                                    -
                                                                                                                    pipelineArtifactBucket: Bucket

                                                                                                                    The pipeline artifact bucket to use

                                                                                                                    -
                                                                                                                    pipelineArtifactPrefix?: string

                                                                                                                    The pipeline artifact bucket prefix to use

                                                                                                                    -
                                                                                                                    pipelineOutputBucket: Bucket

                                                                                                                    The pipeline output bucket to use

                                                                                                                    -
                                                                                                                    pipelineOutputPrefix?: string

                                                                                                                    The pipeline output bucket prefix to use

                                                                                                                    -
                                                                                                                    ecrRepository: IRepository

                                                                                                                    ECR Repository where the Build Host Image resides.

                                                                                                                    -
                                                                                                                    ecrRepositoryImageTag: string

                                                                                                                    Tag for the Build Host Image

                                                                                                                    -
                                                                                                                    projectType: ProjectType

                                                                                                                    The type of project being built.

                                                                                                                    -
                                                                                                                    vpc: IVpc

                                                                                                                    VPC where the networking setup resides.

                                                                                                                    -
                                                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                                                    Additional policy statements to add to the build project.

                                                                                                                    -
                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                    Additional build environment variables to the build project.

                                                                                                                    -
                                                                                                                    encryptionKey: Key

                                                                                                                    The encryption key use across

                                                                                                                    -
                                                                                                                    sourceCustomPath?: string

                                                                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                                                                    -

                                                                                                                    Settings

                                                                                                                    Member Visibility

                                                                                                                    On This Page

                                                                                                                    Properties
                                                                                                                    +
                                                                                                                    propertyInjectors?: IPropertyInjector[]

                                                                                                                    A list of IPropertyInjector attached to this Stack.

                                                                                                                    +
                                                                                                                    - no PropertyInjectors
+
                                                                                                                    + +
                                                                                                                    pipelineSourceBucket: IBucket

                                                                                                                    The pipeline source bucket

                                                                                                                    +
                                                                                                                    pipelineSourcePrefix?: string

                                                                                                                    The pipeline source prefix

                                                                                                                    +
                                                                                                                    pipelineArtifactBucket: Bucket

                                                                                                                    The pipeline artifact bucket to use

                                                                                                                    +
                                                                                                                    pipelineArtifactPrefix?: string

                                                                                                                    The pipeline artifact bucket prefix to use

                                                                                                                    +
                                                                                                                    pipelineOutputBucket: Bucket

                                                                                                                    The pipeline output bucket to use

                                                                                                                    +
                                                                                                                    pipelineOutputPrefix?: string

                                                                                                                    The pipeline output bucket prefix to use

                                                                                                                    +
                                                                                                                    ecrRepository: IRepository

                                                                                                                    ECR Repository where the Build Host Image resides.

                                                                                                                    +
                                                                                                                    ecrRepositoryImageTag: string

                                                                                                                    Tag for the Build Host Image

                                                                                                                    +
                                                                                                                    projectType: ProjectType

                                                                                                                    The type of project being built.

                                                                                                                    +
                                                                                                                    vpc: IVpc

                                                                                                                    VPC where the networking setup resides.

                                                                                                                    +
                                                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                                                    Additional policy statements to add to the build project.

                                                                                                                    +
                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                    Additional build environment variables to the build project.

                                                                                                                    +
                                                                                                                    encryptionKey: Key

                                                                                                                    The encryption key use across

                                                                                                                    +
                                                                                                                    sourceCustomPath?: string

                                                                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                                                                    +

                                                                                                                    Settings

                                                                                                                    Member Visibility

                                                                                                                    On This Page

                                                                                                                    Properties
                                                                                                                    diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 2f46b8f..6b205e2 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                    aws4embeddedlinux-cdk-lib
                                                                                                                      Preparing search index...

                                                                                                                      Interface PipelineResourcesProps

                                                                                                                      Select options for the PipelineResourcesStack.

                                                                                                                      -
                                                                                                                      interface PipelineResourcesProps {
                                                                                                                          description?: string;
                                                                                                                          env?: Environment;
                                                                                                                          stackName?: string;
                                                                                                                          tags?: { [key: string]: string };
                                                                                                                          notificationArns?: string[];
                                                                                                                          synthesizer?: IStackSynthesizer;
                                                                                                                          terminationProtection?: boolean;
                                                                                                                          analyticsReporting?: boolean;
                                                                                                                          crossRegionReferences?: boolean;
                                                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                                                          suppressTemplateIndentation?: boolean;
                                                                                                                          resource_prefix: string;
                                                                                                                          ecrRepositoryName?: string;
                                                                                                                          pipelineArtifactBucketName?: string;
                                                                                                                          pipelineSourceBucketName?: string;
                                                                                                                          pipelineOutputBucketName?: string;
                                                                                                                          loggingBucketName?: string;
                                                                                                                      }

                                                                                                                      Hierarchy

                                                                                                                      • StackProps
                                                                                                                        • PipelineResourcesProps
                                                                                                                      Index

                                                                                                                      Properties

                                                                                                                      description? +
                                                                                                                      interface PipelineResourcesProps {
                                                                                                                          description?: string;
                                                                                                                          env?: Environment;
                                                                                                                          stackName?: string;
                                                                                                                          tags?: { [key: string]: string };
                                                                                                                          notificationArns?: string[];
                                                                                                                          synthesizer?: IStackSynthesizer;
                                                                                                                          terminationProtection?: boolean;
                                                                                                                          analyticsReporting?: boolean;
                                                                                                                          crossRegionReferences?: boolean;
                                                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                                                          suppressTemplateIndentation?: boolean;
                                                                                                                          propertyInjectors?: IPropertyInjector[];
                                                                                                                          resource_prefix: string;
                                                                                                                          ecrRepositoryName?: string;
                                                                                                                          pipelineArtifactBucketName?: string;
                                                                                                                          pipelineSourceBucketName?: string;
                                                                                                                          pipelineOutputBucketName?: string;
                                                                                                                          loggingBucketName?: string;
                                                                                                                      }

                                                                                                                      Hierarchy

                                                                                                                      • StackProps
                                                                                                                        • PipelineResourcesProps
                                                                                                                      Index

                                                                                                                      Properties

                                                                                                                      description? env? stackName? tags? @@ -10,6 +10,7 @@ crossRegionReferences? permissionsBoundary? suppressTemplateIndentation? +propertyInjectors? resource_prefix ecrRepositoryName? pipelineArtifactBucketName? @@ -20,7 +21,7 @@ 
                                                                                                                      - No description.
                                                                                                                      -
                                                                                                                      env?: Environment

                                                                                                                      The AWS environment (account/region) where this stack will be deployed.

                                                                                                                      +
                                                                                                                      env?: Environment

                                                                                                                      The AWS environment (account/region) where this stack will be deployed.

                                                                                                                      Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables @@ -44,19 +45,25 @@

                                                                                                                    • The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
                                                                                                                      • -
                                                                                                                      stackName?: string

                                                                                                                      Name to deploy the stack with

                                                                                                                      +
                                                                                                                      stackName?: string

                                                                                                                      Name to deploy the stack with

                                                                                                                      - Derived from construct path.
                                                                                                                      -
                                                                                                                      tags?: { [key: string]: string }

                                                                                                                      Stack tags that will be applied to all the taggable resources and the stack itself.

                                                                                                                      +
                                                                                                                      tags?: { [key: string]: string }

                                                                                                                      Tags that will be applied to the Stack

                                                                                                                      +

                                                                                                                      These tags are applied to the CloudFormation Stack itself. They will not +appear in the CloudFormation template.

                                                                                                                      +

                                                                                                                      However, at deployment time, CloudFormation will apply these tags to all +resources in the stack that support tagging. You will not be able to exempt +resources from tagging (using the excludeResourceTypes property of +Tags.of(...).add()) for tags applied in this way.

                                                                                                                      {}
                                                                                                                      -
                                                                                                                      notificationArns?: string[]

                                                                                                                      SNS Topic ARNs that will receive stack events.

                                                                                                                      +
                                                                                                                      notificationArns?: string[]

                                                                                                                      SNS Topic ARNs that will receive stack events.

                                                                                                                      - no notfication arns.
                                                                                                                      -
                                                                                                                      synthesizer?: IStackSynthesizer

                                                                                                                      Synthesis method to use while deploying this stack

                                                                                                                      +
                                                                                                                      synthesizer?: IStackSynthesizer

                                                                                                                      Synthesis method to use while deploying this stack

                                                                                                                      The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

                                                                                                                      @@ -68,26 +75,26 @@
                                                                                                                      • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
                                                                                                                      -
                                                                                                                      terminationProtection?: boolean

                                                                                                                      Whether to enable termination protection for this stack.

                                                                                                                      +
                                                                                                                      terminationProtection?: boolean

                                                                                                                      Whether to enable termination protection for this stack.

                                                                                                                      false
                                                                                                                      -
                                                                                                                      analyticsReporting?: boolean

                                                                                                                      Include runtime versioning information in this Stack

                                                                                                                      +
                                                                                                                      analyticsReporting?: boolean

                                                                                                                      Include runtime versioning information in this Stack

                                                                                                                      analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key

                                                                                                                      -
                                                                                                                      crossRegionReferences?: boolean

                                                                                                                      Enable this flag to allow native cross region stack references.

                                                                                                                      +
                                                                                                                      crossRegionReferences?: boolean

                                                                                                                      Enable this flag to allow native cross region stack references.

                                                                                                                      Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

                                                                                                                      This feature is currently experimental

                                                                                                                      false
                                                                                                                      -
                                                                                                                      permissionsBoundary?: PermissionsBoundary

                                                                                                                      Options for applying a permissions boundary to all IAM Roles +

                                                                                                                      permissionsBoundary?: PermissionsBoundary

                                                                                                                      Options for applying a permissions boundary to all IAM Roles and Users created within this Stage

                                                                                                                      - no permissions boundary is applied
                                                                                                                      -
                                                                                                                      suppressTemplateIndentation?: boolean

                                                                                                                      Enable this flag to suppress indentation in generated +

                                                                                                                      suppressTemplateIndentation?: boolean

                                                                                                                      Enable this flag to suppress indentation in generated CloudFormation templates.

                                                                                                                      If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the @@ -95,10 +102,14 @@

                                                                                                                      • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
                                                                                                                      -
                                                                                                                      resource_prefix: string

                                                                                                                      The resource prefix

                                                                                                                      -
                                                                                                                      ecrRepositoryName?: string

                                                                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                      -
                                                                                                                      pipelineArtifactBucketName?: string

                                                                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                      -
                                                                                                                      pipelineSourceBucketName?: string

                                                                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                      -
                                                                                                                      pipelineOutputBucketName?: string

                                                                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                      -
                                                                                                                      loggingBucketName?: string

                                                                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                      -

                                                                                                                      Settings

                                                                                                                      Member Visibility

                                                                                                                      On This Page

                                                                                                                      Properties
                                                                                                                      +
                                                                                                                      propertyInjectors?: IPropertyInjector[]

                                                                                                                      A list of IPropertyInjector attached to this Stack.

                                                                                                                      +
                                                                                                                      - no PropertyInjectors
+
                                                                                                                      + +
                                                                                                                      resource_prefix: string

                                                                                                                      The resource prefix

                                                                                                                      +
                                                                                                                      ecrRepositoryName?: string

                                                                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                      +
                                                                                                                      pipelineArtifactBucketName?: string

                                                                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                      +
                                                                                                                      pipelineSourceBucketName?: string

                                                                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                      +
                                                                                                                      pipelineOutputBucketName?: string

                                                                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                      +
                                                                                                                      loggingBucketName?: string

                                                                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                      +

                                                                                                                      Settings

                                                                                                                      Member Visibility

                                                                                                                      On This Page

                                                                                                                      Properties
                                                                                                                      From 0443e6f1cccc15695a240dccd23dcd9c0d36ec25 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 21 Jul 2025 19:54:13 +0000 Subject: [PATCH 38/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@08f1e55a2294fe567cb8d5696b?= =?UTF-8?q?001aba79d50cfe=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 3609c17..85aae85 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                      aws4embeddedlinux-cdk-lib
                                                                                                                        Preparing search index...

                                                                                                                        Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                        The stack for creating a build pipeline.

                                                                                                                        See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                        -

                                                                                                                        Hierarchy

                                                                                                                        • Stack
                                                                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                        Index

                                                                                                                        Constructors

                                                                                                                        constructor +

                                                                                                                        Hierarchy

                                                                                                                        • Stack
                                                                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                        Index

                                                                                                                        Constructors

                                                                                                                        constructor

                                                                                                                        Properties

                                                                                                                        tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                        Constructors

                                                                                                                        Properties

                                                                                                                        tags: TagManager

                                                                                                                        Tags to be applied to the stack.

                                                                                                                        +

                                                                                                                        Constructors

                                                                                                                        Properties

                                                                                                                        tags: TagManager

                                                                                                                        Tags to be applied to the stack.

                                                                                                                        templateOptions: ITemplateOptions

                                                                                                                        Options for CloudFormation template (like version, transform, description).

                                                                                                                        region: string

                                                                                                                        The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                        This value is resolved according to the following rules:

                                                                                                                        diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index bfe0ea3..5d1a6d7 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                        aws4embeddedlinux-cdk-lib
                                                                                                                          Preparing search index...

                                                                                                                          Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                          The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                          For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                          -

                                                                                                                          Hierarchy

                                                                                                                          • Stack
                                                                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                          Index

                                                                                                                          Constructors

                                                                                                                          constructor +

                                                                                                                          Hierarchy

                                                                                                                          • Stack
                                                                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                          Index

                                                                                                                          Constructors

                                                                                                                          constructor

                                                                                                                          Properties

                                                                                                                          tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                          Constructors

                                                                                                                          Properties

                                                                                                                          tags: TagManager

                                                                                                                          Tags to be applied to the stack.

                                                                                                                          +

                                                                                                                          Constructors

                                                                                                                          Properties

                                                                                                                          tags: TagManager

                                                                                                                          Tags to be applied to the stack.

                                                                                                                          templateOptions: ITemplateOptions

                                                                                                                          Options for CloudFormation template (like version, transform, description).

                                                                                                                          region: string

                                                                                                                          The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                          This value is resolved according to the following rules:

                                                                                                                          @@ -112,8 +112,8 @@

                                                                                                                          Readonly Internal_crossRegionReferences

                                                                                                                          _crossRegionReferences: boolean

                                                                                                                          Whether cross region references are enabled for this stack

                                                                                                                          Optional Readonly Internal_notificationArns

                                                                                                                          _notificationArns?: string[]

                                                                                                                          SNS Notification ARNs to receive stack events.

                                                                                                                          ecrRepository: IRepository

                                                                                                                          The ECR Repository where the image is located.

                                                                                                                          -
                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                          The ECR Image Tag to find the base imaged.

                                                                                                                          -
                                                                                                                          node: Node

                                                                                                                          The tree node.

                                                                                                                          +
                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                          The ECR Image Tag to find the base imaged.

                                                                                                                          +
                                                                                                                          node: Node

                                                                                                                          The tree node.

                                                                                                                          Accessors

                                                                                                                          • get terminationProtection(): boolean

                                                                                                                            Whether termination protection is enabled for this stack.

                                                                                                                            Returns boolean

                                                                                                                          • set terminationProtection(value: boolean): void

                                                                                                                            Parameters

                                                                                                                            • value: boolean

                                                                                                                            Returns void

                                                                                                                          • get dependencies(): Stack[]

                                                                                                                            Return the stacks this stack depends on

                                                                                                                            Returns Stack[]

                                                                                                                          pipelineSourcePrefix?: string

                                                                                                                          The pipeline source prefix

                                                                                                                          +
                                                                                                                          pipelineArtifactBucket: Bucket

                                                                                                                          Artifact bucket to use

                                                                                                                          +
                                                                                                                          ecrRepository: IRepository

                                                                                                                          The ECR Repository to push to.

                                                                                                                          +
                                                                                                                          encryptionKey: Key

                                                                                                                          The encryption key use across

                                                                                                                          +

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          On This Page

                                                                                                                          Properties
                                                                                                                          diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 38cb2f2..cf2de98 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                          aws4embeddedlinux-cdk-lib
                                                                                                                            Preparing search index...

                                                                                                                            Interface EmbeddedLinuxCodePipelineProps

                                                                                                                            Properties to allow customizing the build.

                                                                                                                            -
                                                                                                                            interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                description?: string;
                                                                                                                                env?: Environment;
                                                                                                                                stackName?: string;
                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                notificationArns?: string[];
                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                terminationProtection?: boolean;
                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                pipelineSourceBucket: IBucket;
                                                                                                                                pipelineSourcePrefix?: string;
                                                                                                                                pipelineArtifactBucket: Bucket;
                                                                                                                                pipelineArtifactPrefix?: string;
                                                                                                                                pipelineOutputBucket: Bucket;
                                                                                                                                pipelineOutputPrefix?: string;
                                                                                                                                ecrRepository: IRepository;
                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                projectType: ProjectType;
                                                                                                                                vpc: IVpc;
                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                encryptionKey: Key;
                                                                                                                                sourceCustomPath?: string;
                                                                                                                            }

                                                                                                                            Hierarchy

                                                                                                                            • StackProps
                                                                                                                              • EmbeddedLinuxCodePipelineProps
                                                                                                                            Index

                                                                                                                            Properties

                                                                                                                            description? +
                                                                                                                            interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                description?: string;
                                                                                                                                env?: Environment;
                                                                                                                                stackName?: string;
                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                notificationArns?: string[];
                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                terminationProtection?: boolean;
                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                pipelineSourceBucket: IBucket;
                                                                                                                                pipelineSourcePrefix?: string;
                                                                                                                                pipelineArtifactBucket: Bucket;
                                                                                                                                pipelineArtifactPrefix?: string;
                                                                                                                                pipelineOutputBucket: Bucket;
                                                                                                                                pipelineOutputPrefix?: string;
                                                                                                                                ecrRepository: IRepository;
                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                projectType: ProjectType;
                                                                                                                                vpc: IVpc;
                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                encryptionKey: Key;
                                                                                                                                sourceCustomPath?: string;
                                                                                                                            }

                                                                                                                            Hierarchy

                                                                                                                            • StackProps
                                                                                                                              • EmbeddedLinuxCodePipelineProps
                                                                                                                            Index

                                                                                                                            Properties

                                                                                                                            description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                            pipelineSourceBucket: IBucket

                                                                                                                            The pipeline source bucket

                                                                                                                            -
                                                                                                                            pipelineSourcePrefix?: string

                                                                                                                            The pipeline source prefix

                                                                                                                            -
                                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                                            The pipeline artifact bucket to use

                                                                                                                            -
                                                                                                                            pipelineArtifactPrefix?: string

                                                                                                                            The pipeline artifact bucket prefix to use

                                                                                                                            -
                                                                                                                            pipelineOutputBucket: Bucket

                                                                                                                            The pipeline output bucket to use

                                                                                                                            -
                                                                                                                            pipelineOutputPrefix?: string

                                                                                                                            The pipeline output bucket prefix to use

                                                                                                                            -
                                                                                                                            ecrRepository: IRepository

                                                                                                                            ECR Repository where the Build Host Image resides.

                                                                                                                            -
                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                            Tag for the Build Host Image

                                                                                                                            -
                                                                                                                            projectType: ProjectType

                                                                                                                            The type of project being built.

                                                                                                                            -
                                                                                                                            vpc: IVpc

                                                                                                                            VPC where the networking setup resides.

                                                                                                                            -
                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                            -
                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                            Additional build environment variables to the build project.

                                                                                                                            -
                                                                                                                            encryptionKey: Key

                                                                                                                            The encryption key use across

                                                                                                                            -
                                                                                                                            sourceCustomPath?: string

                                                                                                                            Custom asset to be provided when using ProjectType.Custom

                                                                                                                            -

                                                                                                                            Settings

                                                                                                                            Member Visibility

                                                                                                                            On This Page

                                                                                                                            Properties
                                                                                                                            +
                                                                                                                            pipelineSourcePrefix?: string

                                                                                                                            The pipeline source prefix

                                                                                                                            +
                                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                                            The pipeline artifact bucket to use

                                                                                                                            +
                                                                                                                            pipelineArtifactPrefix?: string

                                                                                                                            The pipeline artifact bucket prefix to use

                                                                                                                            +
                                                                                                                            pipelineOutputBucket: Bucket

                                                                                                                            The pipeline output bucket to use

                                                                                                                            +
                                                                                                                            pipelineOutputPrefix?: string

                                                                                                                            The pipeline output bucket prefix to use

                                                                                                                            +
                                                                                                                            ecrRepository: IRepository

                                                                                                                            ECR Repository where the Build Host Image resides.

                                                                                                                            +
                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                            Tag for the Build Host Image

                                                                                                                            +
                                                                                                                            projectType: ProjectType

                                                                                                                            The type of project being built.

                                                                                                                            +
                                                                                                                            vpc: IVpc

                                                                                                                            VPC where the networking setup resides.

                                                                                                                            +
                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                            +
                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                            Additional build environment variables to the build project.

                                                                                                                            +
                                                                                                                            encryptionKey: Key

                                                                                                                            The encryption key use across

                                                                                                                            +
                                                                                                                            sourceCustomPath?: string

                                                                                                                            Custom asset to be provided when using ProjectType.Custom

                                                                                                                            +

                                                                                                                            Settings

                                                                                                                            Member Visibility

                                                                                                                            On This Page

                                                                                                                            Properties
                                                                                                                            diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 6b205e2..f4cb2b7 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                            aws4embeddedlinux-cdk-lib
                                                                                                                              Preparing search index...

                                                                                                                              Interface PipelineResourcesProps

                                                                                                                              Select options for the PipelineResourcesStack.

                                                                                                                              -
                                                                                                                              interface PipelineResourcesProps {
                                                                                                                                  description?: string;
                                                                                                                                  env?: Environment;
                                                                                                                                  stackName?: string;
                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                  notificationArns?: string[];
                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                  resource_prefix: string;
                                                                                                                                  ecrRepositoryName?: string;
                                                                                                                                  pipelineArtifactBucketName?: string;
                                                                                                                                  pipelineSourceBucketName?: string;
                                                                                                                                  pipelineOutputBucketName?: string;
                                                                                                                                  loggingBucketName?: string;
                                                                                                                              }

                                                                                                                              Hierarchy

                                                                                                                              • StackProps
                                                                                                                                • PipelineResourcesProps
                                                                                                                              Index

                                                                                                                              Properties

                                                                                                                              description? +
                                                                                                                              interface PipelineResourcesProps {
                                                                                                                                  description?: string;
                                                                                                                                  env?: Environment;
                                                                                                                                  stackName?: string;
                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                  notificationArns?: string[];
                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                  resource_prefix: string;
                                                                                                                                  ecrRepositoryName?: string;
                                                                                                                                  pipelineArtifactBucketName?: string;
                                                                                                                                  pipelineSourceBucketName?: string;
                                                                                                                                  pipelineOutputBucketName?: string;
                                                                                                                                  loggingBucketName?: string;
                                                                                                                              }

                                                                                                                              Hierarchy

                                                                                                                              • StackProps
                                                                                                                                • PipelineResourcesProps
                                                                                                                              Index

                                                                                                                              Properties

                                                                                                                              description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                              resource_prefix: string

                                                                                                                              The resource prefix

                                                                                                                              -
                                                                                                                              ecrRepositoryName?: string

                                                                                                                              The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                              -
                                                                                                                              pipelineArtifactBucketName?: string

                                                                                                                              The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                              -
                                                                                                                              pipelineSourceBucketName?: string

                                                                                                                              The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                              -
                                                                                                                              pipelineOutputBucketName?: string

                                                                                                                              The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                              -
                                                                                                                              loggingBucketName?: string

                                                                                                                              Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                              -

                                                                                                                              Settings

                                                                                                                              Member Visibility

                                                                                                                              On This Page

                                                                                                                              Properties
                                                                                                                              +
                                                                                                                              ecrRepositoryName?: string

                                                                                                                              The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                              +
                                                                                                                              pipelineArtifactBucketName?: string

                                                                                                                              The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                              +
                                                                                                                              pipelineSourceBucketName?: string

                                                                                                                              The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                              +
                                                                                                                              pipelineOutputBucketName?: string

                                                                                                                              The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                              +
                                                                                                                              loggingBucketName?: string

                                                                                                                              Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                              +

                                                                                                                              Settings

                                                                                                                              Member Visibility

                                                                                                                              On This Page

                                                                                                                              Properties
                                                                                                                              From 06e346413960a907435aa5f02baa0870951f254e Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 5 Aug 2025 07:32:01 +0000 Subject: [PATCH 39/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@a0dc6dc9bee2257855b34fb7eb?= =?UTF-8?q?0e68439109c716=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 85aae85..10ca090 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                                                Preparing search index...

                                                                                                                                Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                The stack for creating a build pipeline.

                                                                                                                                See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                -

                                                                                                                                Hierarchy

                                                                                                                                • Stack
                                                                                                                                  • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                Index

                                                                                                                                Constructors

                                                                                                                                constructor +

                                                                                                                                Hierarchy

                                                                                                                                • Stack
                                                                                                                                  • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                Index

                                                                                                                                Constructors

                                                                                                                                constructor

                                                                                                                                Properties

                                                                                                                                tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                Constructors

                                                                                                                                Properties

                                                                                                                                tags: TagManager

                                                                                                                                Tags to be applied to the stack.

                                                                                                                                +

                                                                                                                                Constructors

                                                                                                                                Properties

                                                                                                                                tags: TagManager

                                                                                                                                Tags to be applied to the stack.

                                                                                                                                templateOptions: ITemplateOptions

                                                                                                                                Options for CloudFormation template (like version, transform, description).

                                                                                                                                region: string

                                                                                                                                The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                This value is resolved according to the following rules:

                                                                                                                                diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 5d1a6d7..5956571 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                                                  Preparing search index...

                                                                                                                                  Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                  The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                  For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                  -

                                                                                                                                  Hierarchy

                                                                                                                                  • Stack
                                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                  Index

                                                                                                                                  Constructors

                                                                                                                                  constructor +

                                                                                                                                  Hierarchy

                                                                                                                                  • Stack
                                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                  Index

                                                                                                                                  Constructors

                                                                                                                                  constructor

                                                                                                                                  Properties

                                                                                                                                  tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                  Constructors

                                                                                                                                  Properties

                                                                                                                                  tags: TagManager

                                                                                                                                  Tags to be applied to the stack.

                                                                                                                                  +

                                                                                                                                  Constructors

                                                                                                                                  Properties

                                                                                                                                  tags: TagManager

                                                                                                                                  Tags to be applied to the stack.

                                                                                                                                  templateOptions: ITemplateOptions

                                                                                                                                  Options for CloudFormation template (like version, transform, description).

                                                                                                                                  region: string

                                                                                                                                  The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                  This value is resolved according to the following rules:

                                                                                                                                  @@ -112,8 +112,8 @@

                                                                                                                                  Readonly Internal_crossRegionReferences

                                                                                                                                  _crossRegionReferences: boolean

                                                                                                                                  Whether cross region references are enabled for this stack

                                                                                                                                  Optional Readonly Internal_notificationArns

                                                                                                                                  _notificationArns?: string[]

                                                                                                                                  SNS Notification ARNs to receive stack events.

                                                                                                                                  ecrRepository: IRepository

                                                                                                                                  The ECR Repository where the image is located.

                                                                                                                                  -
                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                  The ECR Image Tag to find the base imaged.

                                                                                                                                  -
                                                                                                                                  node: Node

                                                                                                                                  The tree node.

                                                                                                                                  +
                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                  The ECR Image Tag to find the base imaged.

                                                                                                                                  +
                                                                                                                                  node: Node

                                                                                                                                  The tree node.

                                                                                                                                  Accessors

                                                                                                                                  • get terminationProtection(): boolean

                                                                                                                                    Whether termination protection is enabled for this stack.

                                                                                                                                    Returns boolean

                                                                                                                                  • set terminationProtection(value: boolean): void

                                                                                                                                    Parameters

                                                                                                                                    • value: boolean

                                                                                                                                    Returns void

                                                                                                                                  • get dependencies(): Stack[]

                                                                                                                                    Return the stacks this stack depends on

                                                                                                                                    Returns Stack[]

                                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                                  The pipeline source prefix

                                                                                                                                  +
                                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                                  Artifact bucket to use

                                                                                                                                  +
                                                                                                                                  ecrRepository: IRepository

                                                                                                                                  The ECR Repository to push to.

                                                                                                                                  +
                                                                                                                                  encryptionKey: Key

                                                                                                                                  The encryption key use across

                                                                                                                                  +

                                                                                                                                  Settings

                                                                                                                                  Member Visibility

                                                                                                                                  On This Page

                                                                                                                                  Properties
                                                                                                                                  diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index cf2de98..0141b54 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                                                    Preparing search index...

                                                                                                                                    Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                    Properties to allow customizing the build.

                                                                                                                                    -
                                                                                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                        description?: string;
                                                                                                                                        env?: Environment;
                                                                                                                                        stackName?: string;
                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                        notificationArns?: string[];
                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                        pipelineSourceBucket: IBucket;
                                                                                                                                        pipelineSourcePrefix?: string;
                                                                                                                                        pipelineArtifactBucket: Bucket;
                                                                                                                                        pipelineArtifactPrefix?: string;
                                                                                                                                        pipelineOutputBucket: Bucket;
                                                                                                                                        pipelineOutputPrefix?: string;
                                                                                                                                        ecrRepository: IRepository;
                                                                                                                                        ecrRepositoryImageTag: string;
                                                                                                                                        projectType: ProjectType;
                                                                                                                                        vpc: IVpc;
                                                                                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                        encryptionKey: Key;
                                                                                                                                        sourceCustomPath?: string;
                                                                                                                                    }

                                                                                                                                    Hierarchy

                                                                                                                                    • StackProps
                                                                                                                                      • EmbeddedLinuxCodePipelineProps
                                                                                                                                    Index

                                                                                                                                    Properties

                                                                                                                                    description? +
                                                                                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                        description?: string;
                                                                                                                                        env?: Environment;
                                                                                                                                        stackName?: string;
                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                        notificationArns?: string[];
                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                        pipelineSourceBucket: IBucket;
                                                                                                                                        pipelineSourcePrefix?: string;
                                                                                                                                        pipelineArtifactBucket: Bucket;
                                                                                                                                        pipelineArtifactPrefix?: string;
                                                                                                                                        pipelineOutputBucket: Bucket;
                                                                                                                                        pipelineOutputPrefix?: string;
                                                                                                                                        ecrRepository: IRepository;
                                                                                                                                        ecrRepositoryImageTag: string;
                                                                                                                                        projectType: ProjectType;
                                                                                                                                        vpc: IVpc;
                                                                                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                        encryptionKey: Key;
                                                                                                                                        sourceCustomPath?: string;
                                                                                                                                    }

                                                                                                                                    Hierarchy

                                                                                                                                    • StackProps
                                                                                                                                      • EmbeddedLinuxCodePipelineProps
                                                                                                                                    Index

                                                                                                                                    Properties

                                                                                                                                    description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                    pipelineSourceBucket: IBucket

                                                                                                                                    The pipeline source bucket

                                                                                                                                    -
                                                                                                                                    pipelineSourcePrefix?: string

                                                                                                                                    The pipeline source prefix

                                                                                                                                    -
                                                                                                                                    pipelineArtifactBucket: Bucket

                                                                                                                                    The pipeline artifact bucket to use

                                                                                                                                    -
                                                                                                                                    pipelineArtifactPrefix?: string

                                                                                                                                    The pipeline artifact bucket prefix to use

                                                                                                                                    -
                                                                                                                                    pipelineOutputBucket: Bucket

                                                                                                                                    The pipeline output bucket to use

                                                                                                                                    -
                                                                                                                                    pipelineOutputPrefix?: string

                                                                                                                                    The pipeline output bucket prefix to use

                                                                                                                                    -
                                                                                                                                    ecrRepository: IRepository

                                                                                                                                    ECR Repository where the Build Host Image resides.

                                                                                                                                    -
                                                                                                                                    ecrRepositoryImageTag: string

                                                                                                                                    Tag for the Build Host Image

                                                                                                                                    -
                                                                                                                                    projectType: ProjectType

                                                                                                                                    The type of project being built.

                                                                                                                                    -
                                                                                                                                    vpc: IVpc

                                                                                                                                    VPC where the networking setup resides.

                                                                                                                                    -
                                                                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                    Additional policy statements to add to the build project.

                                                                                                                                    -
                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                    Additional build environment variables to the build project.

                                                                                                                                    -
                                                                                                                                    encryptionKey: Key

                                                                                                                                    The encryption key use across

                                                                                                                                    -
                                                                                                                                    sourceCustomPath?: string

                                                                                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                                                                                    -

                                                                                                                                    Settings

                                                                                                                                    Member Visibility

                                                                                                                                    On This Page

                                                                                                                                    Properties
                                                                                                                                    +
                                                                                                                                    pipelineSourcePrefix?: string

                                                                                                                                    The pipeline source prefix

                                                                                                                                    +
                                                                                                                                    pipelineArtifactBucket: Bucket

                                                                                                                                    The pipeline artifact bucket to use

                                                                                                                                    +
                                                                                                                                    pipelineArtifactPrefix?: string

                                                                                                                                    The pipeline artifact bucket prefix to use

                                                                                                                                    +
                                                                                                                                    pipelineOutputBucket: Bucket

                                                                                                                                    The pipeline output bucket to use

                                                                                                                                    +
                                                                                                                                    pipelineOutputPrefix?: string

                                                                                                                                    The pipeline output bucket prefix to use

                                                                                                                                    +
                                                                                                                                    ecrRepository: IRepository

                                                                                                                                    ECR Repository where the Build Host Image resides.

                                                                                                                                    +
                                                                                                                                    ecrRepositoryImageTag: string

                                                                                                                                    Tag for the Build Host Image

                                                                                                                                    +
                                                                                                                                    projectType: ProjectType

                                                                                                                                    The type of project being built.

                                                                                                                                    +
                                                                                                                                    vpc: IVpc

                                                                                                                                    VPC where the networking setup resides.

                                                                                                                                    +
                                                                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                    Additional policy statements to add to the build project.

                                                                                                                                    +
                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                    Additional build environment variables to the build project.

                                                                                                                                    +
                                                                                                                                    encryptionKey: Key

                                                                                                                                    The encryption key use across

                                                                                                                                    +
                                                                                                                                    sourceCustomPath?: string

                                                                                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                                                                                    +

                                                                                                                                    Settings

                                                                                                                                    Member Visibility

                                                                                                                                    On This Page

                                                                                                                                    Properties
                                                                                                                                    diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index f4cb2b7..8522563 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                    aws4embeddedlinux-cdk-lib
                                                                                                                                      Preparing search index...

                                                                                                                                      Interface PipelineResourcesProps

                                                                                                                                      Select options for the PipelineResourcesStack.

                                                                                                                                      -
                                                                                                                                      interface PipelineResourcesProps {
                                                                                                                                          description?: string;
                                                                                                                                          env?: Environment;
                                                                                                                                          stackName?: string;
                                                                                                                                          tags?: { [key: string]: string };
                                                                                                                                          notificationArns?: string[];
                                                                                                                                          synthesizer?: IStackSynthesizer;
                                                                                                                                          terminationProtection?: boolean;
                                                                                                                                          analyticsReporting?: boolean;
                                                                                                                                          crossRegionReferences?: boolean;
                                                                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                                                                          suppressTemplateIndentation?: boolean;
                                                                                                                                          propertyInjectors?: IPropertyInjector[];
                                                                                                                                          resource_prefix: string;
                                                                                                                                          ecrRepositoryName?: string;
                                                                                                                                          pipelineArtifactBucketName?: string;
                                                                                                                                          pipelineSourceBucketName?: string;
                                                                                                                                          pipelineOutputBucketName?: string;
                                                                                                                                          loggingBucketName?: string;
                                                                                                                                      }

                                                                                                                                      Hierarchy

                                                                                                                                      • StackProps
                                                                                                                                        • PipelineResourcesProps
                                                                                                                                      Index

                                                                                                                                      Properties

                                                                                                                                      description? +
                                                                                                                                      interface PipelineResourcesProps {
                                                                                                                                          description?: string;
                                                                                                                                          env?: Environment;
                                                                                                                                          stackName?: string;
                                                                                                                                          tags?: { [key: string]: string };
                                                                                                                                          notificationArns?: string[];
                                                                                                                                          synthesizer?: IStackSynthesizer;
                                                                                                                                          terminationProtection?: boolean;
                                                                                                                                          analyticsReporting?: boolean;
                                                                                                                                          crossRegionReferences?: boolean;
                                                                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                                                                          suppressTemplateIndentation?: boolean;
                                                                                                                                          propertyInjectors?: IPropertyInjector[];
                                                                                                                                          resource_prefix: string;
                                                                                                                                          ecrRepositoryName?: string;
                                                                                                                                          pipelineArtifactBucketName?: string;
                                                                                                                                          pipelineSourceBucketName?: string;
                                                                                                                                          pipelineOutputBucketName?: string;
                                                                                                                                          loggingBucketName?: string;
                                                                                                                                      }

                                                                                                                                      Hierarchy

                                                                                                                                      • StackProps
                                                                                                                                        • PipelineResourcesProps
                                                                                                                                      Index

                                                                                                                                      Properties

                                                                                                                                      description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                      resource_prefix: string

                                                                                                                                      The resource prefix

                                                                                                                                      -
                                                                                                                                      ecrRepositoryName?: string

                                                                                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                      -
                                                                                                                                      pipelineArtifactBucketName?: string

                                                                                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                      -
                                                                                                                                      pipelineSourceBucketName?: string

                                                                                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                      -
                                                                                                                                      pipelineOutputBucketName?: string

                                                                                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                      -
                                                                                                                                      loggingBucketName?: string

                                                                                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                      -

                                                                                                                                      Settings

                                                                                                                                      Member Visibility

                                                                                                                                      On This Page

                                                                                                                                      Properties
                                                                                                                                      +
                                                                                                                                      ecrRepositoryName?: string

                                                                                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                      +
                                                                                                                                      pipelineArtifactBucketName?: string

                                                                                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                      +
                                                                                                                                      pipelineSourceBucketName?: string

                                                                                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                      +
                                                                                                                                      pipelineOutputBucketName?: string

                                                                                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                      +
                                                                                                                                      loggingBucketName?: string

                                                                                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                      +

                                                                                                                                      Settings

                                                                                                                                      Member Visibility

                                                                                                                                      On This Page

                                                                                                                                      Properties
                                                                                                                                      From 9d5f238672f9bb031479898d97c17f7948e21a55 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 5 Aug 2025 07:32:37 +0000 Subject: [PATCH 40/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@1f7b59b455027068a031691a5e?= =?UTF-8?q?1450d7aadcae96=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 10ca090..06cf088 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                      aws4embeddedlinux-cdk-lib
                                                                                                                                        Preparing search index...

                                                                                                                                        Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                        The stack for creating a build pipeline.

                                                                                                                                        See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                        -

                                                                                                                                        Hierarchy

                                                                                                                                        • Stack
                                                                                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                        Index

                                                                                                                                        Constructors

                                                                                                                                        constructor +

                                                                                                                                        Hierarchy

                                                                                                                                        • Stack
                                                                                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                        Index

                                                                                                                                        Constructors

                                                                                                                                        constructor

                                                                                                                                        Properties

                                                                                                                                        tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                        Constructors

                                                                                                                                        Properties

                                                                                                                                        tags: TagManager

                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                        +

                                                                                                                                        Constructors

                                                                                                                                        Properties

                                                                                                                                        tags: TagManager

                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                        templateOptions: ITemplateOptions

                                                                                                                                        Options for CloudFormation template (like version, transform, description).

                                                                                                                                        region: string

                                                                                                                                        The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                        This value is resolved according to the following rules:

                                                                                                                                        diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 5956571..91d66a6 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                        aws4embeddedlinux-cdk-lib
                                                                                                                                          Preparing search index...

                                                                                                                                          Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                          The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                          For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                          -

                                                                                                                                          Hierarchy

                                                                                                                                          • Stack
                                                                                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                          Index

                                                                                                                                          Constructors

                                                                                                                                          constructor +

                                                                                                                                          Hierarchy

                                                                                                                                          • Stack
                                                                                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                          Index

                                                                                                                                          Constructors

                                                                                                                                          constructor

                                                                                                                                          Properties

                                                                                                                                          tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                          Constructors

                                                                                                                                          Properties

                                                                                                                                          tags: TagManager

                                                                                                                                          Tags to be applied to the stack.

                                                                                                                                          +

                                                                                                                                          Constructors

                                                                                                                                          Properties

                                                                                                                                          tags: TagManager

                                                                                                                                          Tags to be applied to the stack.

                                                                                                                                          templateOptions: ITemplateOptions

                                                                                                                                          Options for CloudFormation template (like version, transform, description).

                                                                                                                                          region: string

                                                                                                                                          The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                          This value is resolved according to the following rules:

                                                                                                                                          @@ -112,8 +112,8 @@

                                                                                                                                          Readonly Internal_crossRegionReferences

                                                                                                                                          _crossRegionReferences: boolean

                                                                                                                                          Whether cross region references are enabled for this stack

                                                                                                                                          Optional Readonly Internal_notificationArns

                                                                                                                                          _notificationArns?: string[]

                                                                                                                                          SNS Notification ARNs to receive stack events.

                                                                                                                                          ecrRepository: IRepository

                                                                                                                                          The ECR Repository where the image is located.

                                                                                                                                          -
                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                          The ECR Image Tag to find the base imaged.

                                                                                                                                          -
                                                                                                                                          node: Node

                                                                                                                                          The tree node.

                                                                                                                                          +
                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                          The ECR Image Tag to find the base imaged.

                                                                                                                                          +
                                                                                                                                          node: Node

                                                                                                                                          The tree node.

                                                                                                                                          Accessors

                                                                                                                                          • get terminationProtection(): boolean

                                                                                                                                            Whether termination protection is enabled for this stack.

                                                                                                                                            Returns boolean

                                                                                                                                          • set terminationProtection(value: boolean): void

                                                                                                                                            Parameters

                                                                                                                                            • value: boolean

                                                                                                                                            Returns void

                                                                                                                                          • get dependencies(): Stack[]

                                                                                                                                            Return the stacks this stack depends on

                                                                                                                                            Returns Stack[]

                                                                                                                                          pipelineSourcePrefix?: string

                                                                                                                                          The pipeline source prefix

                                                                                                                                          +
                                                                                                                                          pipelineArtifactBucket: Bucket

                                                                                                                                          Artifact bucket to use

                                                                                                                                          +
                                                                                                                                          ecrRepository: IRepository

                                                                                                                                          The ECR Repository to push to.

                                                                                                                                          +
                                                                                                                                          encryptionKey: Key

                                                                                                                                          The encryption key use across

                                                                                                                                          +

                                                                                                                                          Settings

                                                                                                                                          Member Visibility

                                                                                                                                          On This Page

                                                                                                                                          Properties
                                                                                                                                          diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 0141b54..a193b34 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                          aws4embeddedlinux-cdk-lib
                                                                                                                                            Preparing search index...

                                                                                                                                            Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                            Properties to allow customizing the build.

                                                                                                                                            -
                                                                                                                                            interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                description?: string;
                                                                                                                                                env?: Environment;
                                                                                                                                                stackName?: string;
                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                notificationArns?: string[];
                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                pipelineSourceBucket: IBucket;
                                                                                                                                                pipelineSourcePrefix?: string;
                                                                                                                                                pipelineArtifactBucket: Bucket;
                                                                                                                                                pipelineArtifactPrefix?: string;
                                                                                                                                                pipelineOutputBucket: Bucket;
                                                                                                                                                pipelineOutputPrefix?: string;
                                                                                                                                                ecrRepository: IRepository;
                                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                                projectType: ProjectType;
                                                                                                                                                vpc: IVpc;
                                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                encryptionKey: Key;
                                                                                                                                                sourceCustomPath?: string;
                                                                                                                                            }

                                                                                                                                            Hierarchy

                                                                                                                                            • StackProps
                                                                                                                                              • EmbeddedLinuxCodePipelineProps
                                                                                                                                            Index

                                                                                                                                            Properties

                                                                                                                                            description? +
                                                                                                                                            interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                description?: string;
                                                                                                                                                env?: Environment;
                                                                                                                                                stackName?: string;
                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                notificationArns?: string[];
                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                pipelineSourceBucket: IBucket;
                                                                                                                                                pipelineSourcePrefix?: string;
                                                                                                                                                pipelineArtifactBucket: Bucket;
                                                                                                                                                pipelineArtifactPrefix?: string;
                                                                                                                                                pipelineOutputBucket: Bucket;
                                                                                                                                                pipelineOutputPrefix?: string;
                                                                                                                                                ecrRepository: IRepository;
                                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                                projectType: ProjectType;
                                                                                                                                                vpc: IVpc;
                                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                encryptionKey: Key;
                                                                                                                                                sourceCustomPath?: string;
                                                                                                                                            }

                                                                                                                                            Hierarchy

                                                                                                                                            • StackProps
                                                                                                                                              • EmbeddedLinuxCodePipelineProps
                                                                                                                                            Index

                                                                                                                                            Properties

                                                                                                                                            description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                            pipelineSourceBucket: IBucket

                                                                                                                                            The pipeline source bucket

                                                                                                                                            -
                                                                                                                                            pipelineSourcePrefix?: string

                                                                                                                                            The pipeline source prefix

                                                                                                                                            -
                                                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                                                            The pipeline artifact bucket to use

                                                                                                                                            -
                                                                                                                                            pipelineArtifactPrefix?: string

                                                                                                                                            The pipeline artifact bucket prefix to use

                                                                                                                                            -
                                                                                                                                            pipelineOutputBucket: Bucket

                                                                                                                                            The pipeline output bucket to use

                                                                                                                                            -
                                                                                                                                            pipelineOutputPrefix?: string

                                                                                                                                            The pipeline output bucket prefix to use

                                                                                                                                            -
                                                                                                                                            ecrRepository: IRepository

                                                                                                                                            ECR Repository where the Build Host Image resides.

                                                                                                                                            -
                                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                                            Tag for the Build Host Image

                                                                                                                                            -
                                                                                                                                            projectType: ProjectType

                                                                                                                                            The type of project being built.

                                                                                                                                            -
                                                                                                                                            vpc: IVpc

                                                                                                                                            VPC where the networking setup resides.

                                                                                                                                            -
                                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                                            -
                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                            Additional build environment variables to the build project.

                                                                                                                                            -
                                                                                                                                            encryptionKey: Key

                                                                                                                                            The encryption key use across

                                                                                                                                            -
                                                                                                                                            sourceCustomPath?: string

                                                                                                                                            Custom asset to be provided when using ProjectType.Custom

                                                                                                                                            -

                                                                                                                                            Settings

                                                                                                                                            Member Visibility

                                                                                                                                            On This Page

                                                                                                                                            Properties
                                                                                                                                            +
                                                                                                                                            pipelineSourcePrefix?: string

                                                                                                                                            The pipeline source prefix

                                                                                                                                            +
                                                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                                                            The pipeline artifact bucket to use

                                                                                                                                            +
                                                                                                                                            pipelineArtifactPrefix?: string

                                                                                                                                            The pipeline artifact bucket prefix to use

                                                                                                                                            +
                                                                                                                                            pipelineOutputBucket: Bucket

                                                                                                                                            The pipeline output bucket to use

                                                                                                                                            +
                                                                                                                                            pipelineOutputPrefix?: string

                                                                                                                                            The pipeline output bucket prefix to use

                                                                                                                                            +
                                                                                                                                            ecrRepository: IRepository

                                                                                                                                            ECR Repository where the Build Host Image resides.

                                                                                                                                            +
                                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                                            Tag for the Build Host Image

                                                                                                                                            +
                                                                                                                                            projectType: ProjectType

                                                                                                                                            The type of project being built.

                                                                                                                                            +
                                                                                                                                            vpc: IVpc

                                                                                                                                            VPC where the networking setup resides.

                                                                                                                                            +
                                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                                            +
                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                            Additional build environment variables to the build project.

                                                                                                                                            +
                                                                                                                                            encryptionKey: Key

                                                                                                                                            The encryption key use across

                                                                                                                                            +
                                                                                                                                            sourceCustomPath?: string

                                                                                                                                            Custom asset to be provided when using ProjectType.Custom

                                                                                                                                            +

                                                                                                                                            Settings

                                                                                                                                            Member Visibility

                                                                                                                                            On This Page

                                                                                                                                            Properties
                                                                                                                                            diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 8522563..4e60547 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                            aws4embeddedlinux-cdk-lib
                                                                                                                                              Preparing search index...

                                                                                                                                              Interface PipelineResourcesProps

                                                                                                                                              Select options for the PipelineResourcesStack.

                                                                                                                                              -
                                                                                                                                              interface PipelineResourcesProps {
                                                                                                                                                  description?: string;
                                                                                                                                                  env?: Environment;
                                                                                                                                                  stackName?: string;
                                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                                  notificationArns?: string[];
                                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                                  resource_prefix: string;
                                                                                                                                                  ecrRepositoryName?: string;
                                                                                                                                                  pipelineArtifactBucketName?: string;
                                                                                                                                                  pipelineSourceBucketName?: string;
                                                                                                                                                  pipelineOutputBucketName?: string;
                                                                                                                                                  loggingBucketName?: string;
                                                                                                                                              }

                                                                                                                                              Hierarchy

                                                                                                                                              • StackProps
                                                                                                                                                • PipelineResourcesProps
                                                                                                                                              Index

                                                                                                                                              Properties

                                                                                                                                              description? +
                                                                                                                                              interface PipelineResourcesProps {
                                                                                                                                                  description?: string;
                                                                                                                                                  env?: Environment;
                                                                                                                                                  stackName?: string;
                                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                                  notificationArns?: string[];
                                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                                  resource_prefix: string;
                                                                                                                                                  ecrRepositoryName?: string;
                                                                                                                                                  pipelineArtifactBucketName?: string;
                                                                                                                                                  pipelineSourceBucketName?: string;
                                                                                                                                                  pipelineOutputBucketName?: string;
                                                                                                                                                  loggingBucketName?: string;
                                                                                                                                              }

                                                                                                                                              Hierarchy

                                                                                                                                              • StackProps
                                                                                                                                                • PipelineResourcesProps
                                                                                                                                              Index

                                                                                                                                              Properties

                                                                                                                                              description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                              resource_prefix: string

                                                                                                                                              The resource prefix

                                                                                                                                              -
                                                                                                                                              ecrRepositoryName?: string

                                                                                                                                              The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                              -
                                                                                                                                              pipelineArtifactBucketName?: string

                                                                                                                                              The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                              -
                                                                                                                                              pipelineSourceBucketName?: string

                                                                                                                                              The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                              -
                                                                                                                                              pipelineOutputBucketName?: string

                                                                                                                                              The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                              -
                                                                                                                                              loggingBucketName?: string

                                                                                                                                              Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                              -

                                                                                                                                              Settings

                                                                                                                                              Member Visibility

                                                                                                                                              On This Page

                                                                                                                                              Properties
                                                                                                                                              +
                                                                                                                                              ecrRepositoryName?: string

                                                                                                                                              The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                              +
                                                                                                                                              pipelineArtifactBucketName?: string

                                                                                                                                              The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                              +
                                                                                                                                              pipelineSourceBucketName?: string

                                                                                                                                              The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                              +
                                                                                                                                              pipelineOutputBucketName?: string

                                                                                                                                              The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                              +
                                                                                                                                              loggingBucketName?: string

                                                                                                                                              Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                              +

                                                                                                                                              Settings

                                                                                                                                              Member Visibility

                                                                                                                                              On This Page

                                                                                                                                              Properties
                                                                                                                                              From 45289bdff6ce84f591d345f9b36eb2d864a39942 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 5 Aug 2025 07:42:17 +0000 Subject: [PATCH 41/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@718d1fb789f7b9d7aff0981cbb?= =?UTF-8?q?f7d1be5ec72e30=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 06cf088..ea1f61f 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                                                                Preparing search index...

                                                                                                                                                Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                The stack for creating a build pipeline.

                                                                                                                                                See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                -

                                                                                                                                                Hierarchy

                                                                                                                                                • Stack
                                                                                                                                                  • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                Index

                                                                                                                                                Constructors

                                                                                                                                                constructor +

                                                                                                                                                Hierarchy

                                                                                                                                                • Stack
                                                                                                                                                  • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                Index

                                                                                                                                                Constructors

                                                                                                                                                constructor

                                                                                                                                                Properties

                                                                                                                                                tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                Constructors

                                                                                                                                                Properties

                                                                                                                                                tags: TagManager

                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                +

                                                                                                                                                Constructors

                                                                                                                                                Properties

                                                                                                                                                tags: TagManager

                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                templateOptions: ITemplateOptions

                                                                                                                                                Options for CloudFormation template (like version, transform, description).

                                                                                                                                                region: string

                                                                                                                                                The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                This value is resolved according to the following rules:

                                                                                                                                                diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 91d66a6..dc46834 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                                                                  Preparing search index...

                                                                                                                                                  Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                  The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                  For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                  -

                                                                                                                                                  Hierarchy

                                                                                                                                                  • Stack
                                                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                  Index

                                                                                                                                                  Constructors

                                                                                                                                                  constructor +

                                                                                                                                                  Hierarchy

                                                                                                                                                  • Stack
                                                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                  Index

                                                                                                                                                  Constructors

                                                                                                                                                  constructor

                                                                                                                                                  Properties

                                                                                                                                                  tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                  Constructors

                                                                                                                                                  Properties

                                                                                                                                                  tags: TagManager

                                                                                                                                                  Tags to be applied to the stack.

                                                                                                                                                  +

                                                                                                                                                  Constructors

                                                                                                                                                  Properties

                                                                                                                                                  tags: TagManager

                                                                                                                                                  Tags to be applied to the stack.

                                                                                                                                                  templateOptions: ITemplateOptions

                                                                                                                                                  Options for CloudFormation template (like version, transform, description).

                                                                                                                                                  region: string

                                                                                                                                                  The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                  This value is resolved according to the following rules:

                                                                                                                                                  @@ -112,8 +112,8 @@

                                                                                                                                                  Readonly Internal_crossRegionReferences

                                                                                                                                                  _crossRegionReferences: boolean

                                                                                                                                                  Whether cross region references are enabled for this stack

                                                                                                                                                  Optional Readonly Internal_notificationArns

                                                                                                                                                  _notificationArns?: string[]

                                                                                                                                                  SNS Notification ARNs to receive stack events.

                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                  The ECR Repository where the image is located.

                                                                                                                                                  -
                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                  The ECR Image Tag to find the base imaged.

                                                                                                                                                  -
                                                                                                                                                  node: Node

                                                                                                                                                  The tree node.

                                                                                                                                                  +
                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                  The ECR Image Tag to find the base imaged.

                                                                                                                                                  +
                                                                                                                                                  node: Node

                                                                                                                                                  The tree node.

                                                                                                                                                  Accessors

                                                                                                                                                  • get terminationProtection(): boolean

                                                                                                                                                    Whether termination protection is enabled for this stack.

                                                                                                                                                    Returns boolean

                                                                                                                                                  • set terminationProtection(value: boolean): void

                                                                                                                                                    Parameters

                                                                                                                                                    • value: boolean

                                                                                                                                                    Returns void

                                                                                                                                                  • get dependencies(): Stack[]

                                                                                                                                                    Return the stacks this stack depends on

                                                                                                                                                    Returns Stack[]

                                                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                                                  The pipeline source prefix

                                                                                                                                                  +
                                                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                                                  Artifact bucket to use

                                                                                                                                                  +
                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                  The ECR Repository to push to.

                                                                                                                                                  +
                                                                                                                                                  encryptionKey: Key

                                                                                                                                                  The encryption key use across

                                                                                                                                                  +

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  On This Page

                                                                                                                                                  Properties
                                                                                                                                                  diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index a193b34..2ca4958 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                                                                    Preparing search index...

                                                                                                                                                    Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                    Properties to allow customizing the build.

                                                                                                                                                    -
                                                                                                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                        description?: string;
                                                                                                                                                        env?: Environment;
                                                                                                                                                        stackName?: string;
                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                        pipelineSourceBucket: IBucket;
                                                                                                                                                        pipelineSourcePrefix?: string;
                                                                                                                                                        pipelineArtifactBucket: Bucket;
                                                                                                                                                        pipelineArtifactPrefix?: string;
                                                                                                                                                        pipelineOutputBucket: Bucket;
                                                                                                                                                        pipelineOutputPrefix?: string;
                                                                                                                                                        ecrRepository: IRepository;
                                                                                                                                                        ecrRepositoryImageTag: string;
                                                                                                                                                        projectType: ProjectType;
                                                                                                                                                        vpc: IVpc;
                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                        encryptionKey: Key;
                                                                                                                                                        sourceCustomPath?: string;
                                                                                                                                                    }

                                                                                                                                                    Hierarchy

                                                                                                                                                    • StackProps
                                                                                                                                                      • EmbeddedLinuxCodePipelineProps
                                                                                                                                                    Index

                                                                                                                                                    Properties

                                                                                                                                                    description? +
                                                                                                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                        description?: string;
                                                                                                                                                        env?: Environment;
                                                                                                                                                        stackName?: string;
                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                        pipelineSourceBucket: IBucket;
                                                                                                                                                        pipelineSourcePrefix?: string;
                                                                                                                                                        pipelineArtifactBucket: Bucket;
                                                                                                                                                        pipelineArtifactPrefix?: string;
                                                                                                                                                        pipelineOutputBucket: Bucket;
                                                                                                                                                        pipelineOutputPrefix?: string;
                                                                                                                                                        ecrRepository: IRepository;
                                                                                                                                                        ecrRepositoryImageTag: string;
                                                                                                                                                        projectType: ProjectType;
                                                                                                                                                        vpc: IVpc;
                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                        encryptionKey: Key;
                                                                                                                                                        sourceCustomPath?: string;
                                                                                                                                                    }

                                                                                                                                                    Hierarchy

                                                                                                                                                    • StackProps
                                                                                                                                                      • EmbeddedLinuxCodePipelineProps
                                                                                                                                                    Index

                                                                                                                                                    Properties

                                                                                                                                                    description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                    pipelineSourceBucket: IBucket

                                                                                                                                                    The pipeline source bucket

                                                                                                                                                    -
                                                                                                                                                    pipelineSourcePrefix?: string

                                                                                                                                                    The pipeline source prefix

                                                                                                                                                    -
                                                                                                                                                    pipelineArtifactBucket: Bucket

                                                                                                                                                    The pipeline artifact bucket to use

                                                                                                                                                    -
                                                                                                                                                    pipelineArtifactPrefix?: string

                                                                                                                                                    The pipeline artifact bucket prefix to use

                                                                                                                                                    -
                                                                                                                                                    pipelineOutputBucket: Bucket

                                                                                                                                                    The pipeline output bucket to use

                                                                                                                                                    -
                                                                                                                                                    pipelineOutputPrefix?: string

                                                                                                                                                    The pipeline output bucket prefix to use

                                                                                                                                                    -
                                                                                                                                                    ecrRepository: IRepository

                                                                                                                                                    ECR Repository where the Build Host Image resides.

                                                                                                                                                    -
                                                                                                                                                    ecrRepositoryImageTag: string

                                                                                                                                                    Tag for the Build Host Image

                                                                                                                                                    -
                                                                                                                                                    projectType: ProjectType

                                                                                                                                                    The type of project being built.

                                                                                                                                                    -
                                                                                                                                                    vpc: IVpc

                                                                                                                                                    VPC where the networking setup resides.

                                                                                                                                                    -
                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                    Additional policy statements to add to the build project.

                                                                                                                                                    -
                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                    Additional build environment variables to the build project.

                                                                                                                                                    -
                                                                                                                                                    encryptionKey: Key

                                                                                                                                                    The encryption key use across

                                                                                                                                                    -
                                                                                                                                                    sourceCustomPath?: string

                                                                                                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                    -

                                                                                                                                                    Settings

                                                                                                                                                    Member Visibility

                                                                                                                                                    On This Page

                                                                                                                                                    Properties
                                                                                                                                                    +
                                                                                                                                                    pipelineSourcePrefix?: string

                                                                                                                                                    The pipeline source prefix

                                                                                                                                                    +
                                                                                                                                                    pipelineArtifactBucket: Bucket

                                                                                                                                                    The pipeline artifact bucket to use

                                                                                                                                                    +
                                                                                                                                                    pipelineArtifactPrefix?: string

                                                                                                                                                    The pipeline artifact bucket prefix to use

                                                                                                                                                    +
                                                                                                                                                    pipelineOutputBucket: Bucket

                                                                                                                                                    The pipeline output bucket to use

                                                                                                                                                    +
                                                                                                                                                    pipelineOutputPrefix?: string

                                                                                                                                                    The pipeline output bucket prefix to use

                                                                                                                                                    +
                                                                                                                                                    ecrRepository: IRepository

                                                                                                                                                    ECR Repository where the Build Host Image resides.

                                                                                                                                                    +
                                                                                                                                                    ecrRepositoryImageTag: string

                                                                                                                                                    Tag for the Build Host Image

                                                                                                                                                    +
                                                                                                                                                    projectType: ProjectType

                                                                                                                                                    The type of project being built.

                                                                                                                                                    +
                                                                                                                                                    vpc: IVpc

                                                                                                                                                    VPC where the networking setup resides.

                                                                                                                                                    +
                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                    Additional policy statements to add to the build project.

                                                                                                                                                    +
                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                    Additional build environment variables to the build project.

                                                                                                                                                    +
                                                                                                                                                    encryptionKey: Key

                                                                                                                                                    The encryption key use across

                                                                                                                                                    +
                                                                                                                                                    sourceCustomPath?: string

                                                                                                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                    +

                                                                                                                                                    Settings

                                                                                                                                                    Member Visibility

                                                                                                                                                    On This Page

                                                                                                                                                    Properties
                                                                                                                                                    diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 4e60547..d42c608 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                    aws4embeddedlinux-cdk-lib
                                                                                                                                                      Preparing search index...

                                                                                                                                                      Interface PipelineResourcesProps

                                                                                                                                                      Select options for the PipelineResourcesStack.

                                                                                                                                                      -
                                                                                                                                                      interface PipelineResourcesProps {
                                                                                                                                                          description?: string;
                                                                                                                                                          env?: Environment;
                                                                                                                                                          stackName?: string;
                                                                                                                                                          tags?: { [key: string]: string };
                                                                                                                                                          notificationArns?: string[];
                                                                                                                                                          synthesizer?: IStackSynthesizer;
                                                                                                                                                          terminationProtection?: boolean;
                                                                                                                                                          analyticsReporting?: boolean;
                                                                                                                                                          crossRegionReferences?: boolean;
                                                                                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                          suppressTemplateIndentation?: boolean;
                                                                                                                                                          propertyInjectors?: IPropertyInjector[];
                                                                                                                                                          resource_prefix: string;
                                                                                                                                                          ecrRepositoryName?: string;
                                                                                                                                                          pipelineArtifactBucketName?: string;
                                                                                                                                                          pipelineSourceBucketName?: string;
                                                                                                                                                          pipelineOutputBucketName?: string;
                                                                                                                                                          loggingBucketName?: string;
                                                                                                                                                      }

                                                                                                                                                      Hierarchy

                                                                                                                                                      • StackProps
                                                                                                                                                        • PipelineResourcesProps
                                                                                                                                                      Index

                                                                                                                                                      Properties

                                                                                                                                                      description? +
                                                                                                                                                      interface PipelineResourcesProps {
                                                                                                                                                          description?: string;
                                                                                                                                                          env?: Environment;
                                                                                                                                                          stackName?: string;
                                                                                                                                                          tags?: { [key: string]: string };
                                                                                                                                                          notificationArns?: string[];
                                                                                                                                                          synthesizer?: IStackSynthesizer;
                                                                                                                                                          terminationProtection?: boolean;
                                                                                                                                                          analyticsReporting?: boolean;
                                                                                                                                                          crossRegionReferences?: boolean;
                                                                                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                          suppressTemplateIndentation?: boolean;
                                                                                                                                                          propertyInjectors?: IPropertyInjector[];
                                                                                                                                                          resource_prefix: string;
                                                                                                                                                          ecrRepositoryName?: string;
                                                                                                                                                          pipelineArtifactBucketName?: string;
                                                                                                                                                          pipelineSourceBucketName?: string;
                                                                                                                                                          pipelineOutputBucketName?: string;
                                                                                                                                                          loggingBucketName?: string;
                                                                                                                                                      }

                                                                                                                                                      Hierarchy

                                                                                                                                                      • StackProps
                                                                                                                                                        • PipelineResourcesProps
                                                                                                                                                      Index

                                                                                                                                                      Properties

                                                                                                                                                      description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                      resource_prefix: string

                                                                                                                                                      The resource prefix

                                                                                                                                                      -
                                                                                                                                                      ecrRepositoryName?: string

                                                                                                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                      -
                                                                                                                                                      pipelineArtifactBucketName?: string

                                                                                                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                      -
                                                                                                                                                      pipelineSourceBucketName?: string

                                                                                                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                      -
                                                                                                                                                      pipelineOutputBucketName?: string

                                                                                                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                      -
                                                                                                                                                      loggingBucketName?: string

                                                                                                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                      -

                                                                                                                                                      Settings

                                                                                                                                                      Member Visibility

                                                                                                                                                      On This Page

                                                                                                                                                      Properties
                                                                                                                                                      +
                                                                                                                                                      ecrRepositoryName?: string

                                                                                                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                      +
                                                                                                                                                      pipelineArtifactBucketName?: string

                                                                                                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                      +
                                                                                                                                                      pipelineSourceBucketName?: string

                                                                                                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                      +
                                                                                                                                                      pipelineOutputBucketName?: string

                                                                                                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                      +
                                                                                                                                                      loggingBucketName?: string

                                                                                                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                      +

                                                                                                                                                      Settings

                                                                                                                                                      Member Visibility

                                                                                                                                                      On This Page

                                                                                                                                                      Properties
                                                                                                                                                      From 97fa6a1b48c7ae3ce9b92439975d354e2cc84166 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 1 Sep 2025 10:09:39 +0000 Subject: [PATCH 42/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@b17ddd5a962712cb4de1159631?= =?UTF-8?q?9e5fe23ca78e33=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index ea1f61f..dceaac9 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                      aws4embeddedlinux-cdk-lib
                                                                                                                                                        Preparing search index...

                                                                                                                                                        Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                        The stack for creating a build pipeline.

                                                                                                                                                        See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                        -

                                                                                                                                                        Hierarchy

                                                                                                                                                        • Stack
                                                                                                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                        Index

                                                                                                                                                        Constructors

                                                                                                                                                        constructor +

                                                                                                                                                        Hierarchy

                                                                                                                                                        • Stack
                                                                                                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                        Index

                                                                                                                                                        Constructors

                                                                                                                                                        constructor

                                                                                                                                                        Properties

                                                                                                                                                        tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                        Constructors

                                                                                                                                                        Properties

                                                                                                                                                        tags: TagManager

                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                        +

                                                                                                                                                        Constructors

                                                                                                                                                        Properties

                                                                                                                                                        tags: TagManager

                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                        templateOptions: ITemplateOptions

                                                                                                                                                        Options for CloudFormation template (like version, transform, description).

                                                                                                                                                        region: string

                                                                                                                                                        The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                        This value is resolved according to the following rules:

                                                                                                                                                        diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index dc46834..bf6d9c4 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                        aws4embeddedlinux-cdk-lib
                                                                                                                                                          Preparing search index...

                                                                                                                                                          Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                          The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                          For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                          -

                                                                                                                                                          Hierarchy

                                                                                                                                                          • Stack
                                                                                                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                          Index

                                                                                                                                                          Constructors

                                                                                                                                                          constructor +

                                                                                                                                                          Hierarchy

                                                                                                                                                          • Stack
                                                                                                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                          Index

                                                                                                                                                          Constructors

                                                                                                                                                          constructor

                                                                                                                                                          Properties

                                                                                                                                                          tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                          Constructors

                                                                                                                                                          Properties

                                                                                                                                                          tags: TagManager

                                                                                                                                                          Tags to be applied to the stack.

                                                                                                                                                          +

                                                                                                                                                          Constructors

                                                                                                                                                          Properties

                                                                                                                                                          tags: TagManager

                                                                                                                                                          Tags to be applied to the stack.

                                                                                                                                                          templateOptions: ITemplateOptions

                                                                                                                                                          Options for CloudFormation template (like version, transform, description).

                                                                                                                                                          region: string

                                                                                                                                                          The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                          This value is resolved according to the following rules:

                                                                                                                                                          @@ -112,8 +112,8 @@

                                                                                                                                                          Readonly Internal_crossRegionReferences

                                                                                                                                                          _crossRegionReferences: boolean

                                                                                                                                                          Whether cross region references are enabled for this stack

                                                                                                                                                          Optional Readonly Internal_notificationArns

                                                                                                                                                          _notificationArns?: string[]

                                                                                                                                                          SNS Notification ARNs to receive stack events.

                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                          The ECR Repository where the image is located.

                                                                                                                                                          -
                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                          The ECR Image Tag to find the base imaged.

                                                                                                                                                          -
                                                                                                                                                          node: Node

                                                                                                                                                          The tree node.

                                                                                                                                                          +
                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                          The ECR Image Tag to find the base imaged.

                                                                                                                                                          +
                                                                                                                                                          node: Node

                                                                                                                                                          The tree node.

                                                                                                                                                          Accessors

                                                                                                                                                          • get terminationProtection(): boolean

                                                                                                                                                            Whether termination protection is enabled for this stack.

                                                                                                                                                            Returns boolean

                                                                                                                                                          • set terminationProtection(value: boolean): void

                                                                                                                                                            Parameters

                                                                                                                                                            • value: boolean

                                                                                                                                                            Returns void

                                                                                                                                                          • get dependencies(): Stack[]

                                                                                                                                                            Return the stacks this stack depends on

                                                                                                                                                            Returns Stack[]

                                                                                                                                                          pipelineSourcePrefix?: string

                                                                                                                                                          The pipeline source prefix

                                                                                                                                                          +
                                                                                                                                                          pipelineArtifactBucket: Bucket

                                                                                                                                                          Artifact bucket to use

                                                                                                                                                          +
                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                          The ECR Repository to push to.

                                                                                                                                                          +
                                                                                                                                                          encryptionKey: Key

                                                                                                                                                          The encryption key use across

                                                                                                                                                          +

                                                                                                                                                          Settings

                                                                                                                                                          Member Visibility

                                                                                                                                                          On This Page

                                                                                                                                                          Properties
                                                                                                                                                          diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 2ca4958..392c97f 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                          aws4embeddedlinux-cdk-lib
                                                                                                                                                            Preparing search index...

                                                                                                                                                            Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                            Properties to allow customizing the build.

                                                                                                                                                            -
                                                                                                                                                            interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                description?: string;
                                                                                                                                                                env?: Environment;
                                                                                                                                                                stackName?: string;
                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                pipelineSourceBucket: IBucket;
                                                                                                                                                                pipelineSourcePrefix?: string;
                                                                                                                                                                pipelineArtifactBucket: Bucket;
                                                                                                                                                                pipelineArtifactPrefix?: string;
                                                                                                                                                                pipelineOutputBucket: Bucket;
                                                                                                                                                                pipelineOutputPrefix?: string;
                                                                                                                                                                ecrRepository: IRepository;
                                                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                                                projectType: ProjectType;
                                                                                                                                                                vpc: IVpc;
                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                encryptionKey: Key;
                                                                                                                                                                sourceCustomPath?: string;
                                                                                                                                                            }

                                                                                                                                                            Hierarchy

                                                                                                                                                            • StackProps
                                                                                                                                                              • EmbeddedLinuxCodePipelineProps
                                                                                                                                                            Index

                                                                                                                                                            Properties

                                                                                                                                                            description? +
                                                                                                                                                            interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                description?: string;
                                                                                                                                                                env?: Environment;
                                                                                                                                                                stackName?: string;
                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                pipelineSourceBucket: IBucket;
                                                                                                                                                                pipelineSourcePrefix?: string;
                                                                                                                                                                pipelineArtifactBucket: Bucket;
                                                                                                                                                                pipelineArtifactPrefix?: string;
                                                                                                                                                                pipelineOutputBucket: Bucket;
                                                                                                                                                                pipelineOutputPrefix?: string;
                                                                                                                                                                ecrRepository: IRepository;
                                                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                                                projectType: ProjectType;
                                                                                                                                                                vpc: IVpc;
                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                encryptionKey: Key;
                                                                                                                                                                sourceCustomPath?: string;
                                                                                                                                                            }

                                                                                                                                                            Hierarchy

                                                                                                                                                            • StackProps
                                                                                                                                                              • EmbeddedLinuxCodePipelineProps
                                                                                                                                                            Index

                                                                                                                                                            Properties

                                                                                                                                                            description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                            pipelineSourceBucket: IBucket

                                                                                                                                                            The pipeline source bucket

                                                                                                                                                            -
                                                                                                                                                            pipelineSourcePrefix?: string

                                                                                                                                                            The pipeline source prefix

                                                                                                                                                            -
                                                                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                                                                            The pipeline artifact bucket to use

                                                                                                                                                            -
                                                                                                                                                            pipelineArtifactPrefix?: string

                                                                                                                                                            The pipeline artifact bucket prefix to use

                                                                                                                                                            -
                                                                                                                                                            pipelineOutputBucket: Bucket

                                                                                                                                                            The pipeline output bucket to use

                                                                                                                                                            -
                                                                                                                                                            pipelineOutputPrefix?: string

                                                                                                                                                            The pipeline output bucket prefix to use

                                                                                                                                                            -
                                                                                                                                                            ecrRepository: IRepository

                                                                                                                                                            ECR Repository where the Build Host Image resides.

                                                                                                                                                            -
                                                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                                                            Tag for the Build Host Image

                                                                                                                                                            -
                                                                                                                                                            projectType: ProjectType

                                                                                                                                                            The type of project being built.

                                                                                                                                                            -
                                                                                                                                                            vpc: IVpc

                                                                                                                                                            VPC where the networking setup resides.

                                                                                                                                                            -
                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                                                            -
                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                            Additional build environment variables to the build project.

                                                                                                                                                            -
                                                                                                                                                            encryptionKey: Key

                                                                                                                                                            The encryption key use across

                                                                                                                                                            -
                                                                                                                                                            sourceCustomPath?: string

                                                                                                                                                            Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                            -

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility

                                                                                                                                                            On This Page

                                                                                                                                                            Properties
                                                                                                                                                            +
                                                                                                                                                            pipelineSourcePrefix?: string

                                                                                                                                                            The pipeline source prefix

                                                                                                                                                            +
                                                                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                                                                            The pipeline artifact bucket to use

                                                                                                                                                            +
                                                                                                                                                            pipelineArtifactPrefix?: string

                                                                                                                                                            The pipeline artifact bucket prefix to use

                                                                                                                                                            +
                                                                                                                                                            pipelineOutputBucket: Bucket

                                                                                                                                                            The pipeline output bucket to use

                                                                                                                                                            +
                                                                                                                                                            pipelineOutputPrefix?: string

                                                                                                                                                            The pipeline output bucket prefix to use

                                                                                                                                                            +
                                                                                                                                                            ecrRepository: IRepository

                                                                                                                                                            ECR Repository where the Build Host Image resides.

                                                                                                                                                            +
                                                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                                                            Tag for the Build Host Image

                                                                                                                                                            +
                                                                                                                                                            projectType: ProjectType

                                                                                                                                                            The type of project being built.

                                                                                                                                                            +
                                                                                                                                                            vpc: IVpc

                                                                                                                                                            VPC where the networking setup resides.

                                                                                                                                                            +
                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                                                            +
                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                            Additional build environment variables to the build project.

                                                                                                                                                            +
                                                                                                                                                            encryptionKey: Key

                                                                                                                                                            The encryption key use across

                                                                                                                                                            +
                                                                                                                                                            sourceCustomPath?: string

                                                                                                                                                            Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                            +

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility

                                                                                                                                                            On This Page

                                                                                                                                                            Properties
                                                                                                                                                            diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index d42c608..dcf35aa 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                            aws4embeddedlinux-cdk-lib
                                                                                                                                                              Preparing search index...

                                                                                                                                                              Interface PipelineResourcesProps

                                                                                                                                                              Select options for the PipelineResourcesStack.

                                                                                                                                                              -
                                                                                                                                                              interface PipelineResourcesProps {
                                                                                                                                                                  description?: string;
                                                                                                                                                                  env?: Environment;
                                                                                                                                                                  stackName?: string;
                                                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                                                  notificationArns?: string[];
                                                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                  resource_prefix: string;
                                                                                                                                                                  ecrRepositoryName?: string;
                                                                                                                                                                  pipelineArtifactBucketName?: string;
                                                                                                                                                                  pipelineSourceBucketName?: string;
                                                                                                                                                                  pipelineOutputBucketName?: string;
                                                                                                                                                                  loggingBucketName?: string;
                                                                                                                                                              }

                                                                                                                                                              Hierarchy

                                                                                                                                                              • StackProps
                                                                                                                                                                • PipelineResourcesProps
                                                                                                                                                              Index

                                                                                                                                                              Properties

                                                                                                                                                              description? +
                                                                                                                                                              interface PipelineResourcesProps {
                                                                                                                                                                  description?: string;
                                                                                                                                                                  env?: Environment;
                                                                                                                                                                  stackName?: string;
                                                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                                                  notificationArns?: string[];
                                                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                  resource_prefix: string;
                                                                                                                                                                  ecrRepositoryName?: string;
                                                                                                                                                                  pipelineArtifactBucketName?: string;
                                                                                                                                                                  pipelineSourceBucketName?: string;
                                                                                                                                                                  pipelineOutputBucketName?: string;
                                                                                                                                                                  loggingBucketName?: string;
                                                                                                                                                              }

                                                                                                                                                              Hierarchy

                                                                                                                                                              • StackProps
                                                                                                                                                                • PipelineResourcesProps
                                                                                                                                                              Index

                                                                                                                                                              Properties

                                                                                                                                                              description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                              resource_prefix: string

                                                                                                                                                              The resource prefix

                                                                                                                                                              -
                                                                                                                                                              ecrRepositoryName?: string

                                                                                                                                                              The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                              -
                                                                                                                                                              pipelineArtifactBucketName?: string

                                                                                                                                                              The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                              -
                                                                                                                                                              pipelineSourceBucketName?: string

                                                                                                                                                              The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                              -
                                                                                                                                                              pipelineOutputBucketName?: string

                                                                                                                                                              The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                              -
                                                                                                                                                              loggingBucketName?: string

                                                                                                                                                              Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                              -

                                                                                                                                                              Settings

                                                                                                                                                              Member Visibility

                                                                                                                                                              On This Page

                                                                                                                                                              Properties
                                                                                                                                                              +
                                                                                                                                                              ecrRepositoryName?: string

                                                                                                                                                              The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                              +
                                                                                                                                                              pipelineArtifactBucketName?: string

                                                                                                                                                              The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                              +
                                                                                                                                                              pipelineSourceBucketName?: string

                                                                                                                                                              The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                              +
                                                                                                                                                              pipelineOutputBucketName?: string

                                                                                                                                                              The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                              +
                                                                                                                                                              loggingBucketName?: string

                                                                                                                                                              Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                              +

                                                                                                                                                              Settings

                                                                                                                                                              Member Visibility

                                                                                                                                                              On This Page

                                                                                                                                                              Properties
                                                                                                                                                              From ccfa6d1ab2e9569e369e76bef466f14fc02fab2a Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 1 Sep 2025 10:09:50 +0000 Subject: [PATCH 43/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@7f506d888e9d126f3ef0484847?= =?UTF-8?q?90edf856c12800=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index dceaac9..6639092 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                                                                                Preparing search index...

                                                                                                                                                                Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                The stack for creating a build pipeline.

                                                                                                                                                                See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                -

                                                                                                                                                                Hierarchy

                                                                                                                                                                • Stack
                                                                                                                                                                  • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                Index

                                                                                                                                                                Constructors

                                                                                                                                                                constructor +

                                                                                                                                                                Hierarchy

                                                                                                                                                                • Stack
                                                                                                                                                                  • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                Index

                                                                                                                                                                Constructors

                                                                                                                                                                constructor

                                                                                                                                                                Properties

                                                                                                                                                                tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                Constructors

                                                                                                                                                                Properties

                                                                                                                                                                tags: TagManager

                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                +

                                                                                                                                                                Constructors

                                                                                                                                                                Properties

                                                                                                                                                                tags: TagManager

                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                templateOptions: ITemplateOptions

                                                                                                                                                                Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                region: string

                                                                                                                                                                The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                This value is resolved according to the following rules:

                                                                                                                                                                diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index bf6d9c4..f4e5141 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                                                                                  Preparing search index...

                                                                                                                                                                  Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                  The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                  For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                  -

                                                                                                                                                                  Hierarchy

                                                                                                                                                                  • Stack
                                                                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                  Index

                                                                                                                                                                  Constructors

                                                                                                                                                                  constructor +

                                                                                                                                                                  Hierarchy

                                                                                                                                                                  • Stack
                                                                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                  Index

                                                                                                                                                                  Constructors

                                                                                                                                                                  constructor

                                                                                                                                                                  Properties

                                                                                                                                                                  tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                  Constructors

                                                                                                                                                                  Properties

                                                                                                                                                                  tags: TagManager

                                                                                                                                                                  Tags to be applied to the stack.

                                                                                                                                                                  +

                                                                                                                                                                  Constructors

                                                                                                                                                                  Properties

                                                                                                                                                                  tags: TagManager

                                                                                                                                                                  Tags to be applied to the stack.

                                                                                                                                                                  templateOptions: ITemplateOptions

                                                                                                                                                                  Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                  region: string

                                                                                                                                                                  The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                  This value is resolved according to the following rules:

                                                                                                                                                                  @@ -112,8 +112,8 @@

                                                                                                                                                                  Readonly Internal_crossRegionReferences

                                                                                                                                                                  _crossRegionReferences: boolean

                                                                                                                                                                  Whether cross region references are enabled for this stack

                                                                                                                                                                  Optional Readonly Internal_notificationArns

                                                                                                                                                                  _notificationArns?: string[]

                                                                                                                                                                  SNS Notification ARNs to receive stack events.

                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                  The ECR Repository where the image is located.

                                                                                                                                                                  -
                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                  The ECR Image Tag to find the base imaged.

                                                                                                                                                                  -
                                                                                                                                                                  node: Node

                                                                                                                                                                  The tree node.

                                                                                                                                                                  +
                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                  The ECR Image Tag to find the base imaged.

                                                                                                                                                                  +
                                                                                                                                                                  node: Node

                                                                                                                                                                  The tree node.

                                                                                                                                                                  Accessors

                                                                                                                                                                  • get terminationProtection(): boolean

                                                                                                                                                                    Whether termination protection is enabled for this stack.

                                                                                                                                                                    Returns boolean

                                                                                                                                                                  • set terminationProtection(value: boolean): void

                                                                                                                                                                    Parameters

                                                                                                                                                                    • value: boolean

                                                                                                                                                                    Returns void

                                                                                                                                                                  • get dependencies(): Stack[]

                                                                                                                                                                    Return the stacks this stack depends on

                                                                                                                                                                    Returns Stack[]

                                                                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                                                                  The pipeline source prefix

                                                                                                                                                                  +
                                                                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                                                                  Artifact bucket to use

                                                                                                                                                                  +
                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                  The ECR Repository to push to.

                                                                                                                                                                  +
                                                                                                                                                                  encryptionKey: Key

                                                                                                                                                                  The encryption key use across

                                                                                                                                                                  +

                                                                                                                                                                  Settings

                                                                                                                                                                  Member Visibility

                                                                                                                                                                  On This Page

                                                                                                                                                                  Properties
                                                                                                                                                                  diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 392c97f..10f1262 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                                                                                    Preparing search index...

                                                                                                                                                                    Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                    Properties to allow customizing the build.

                                                                                                                                                                    -
                                                                                                                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                        description?: string;
                                                                                                                                                                        env?: Environment;
                                                                                                                                                                        stackName?: string;
                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                        pipelineSourceBucket: IBucket;
                                                                                                                                                                        pipelineSourcePrefix?: string;
                                                                                                                                                                        pipelineArtifactBucket: Bucket;
                                                                                                                                                                        pipelineArtifactPrefix?: string;
                                                                                                                                                                        pipelineOutputBucket: Bucket;
                                                                                                                                                                        pipelineOutputPrefix?: string;
                                                                                                                                                                        ecrRepository: IRepository;
                                                                                                                                                                        ecrRepositoryImageTag: string;
                                                                                                                                                                        projectType: ProjectType;
                                                                                                                                                                        vpc: IVpc;
                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                        encryptionKey: Key;
                                                                                                                                                                        sourceCustomPath?: string;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy

                                                                                                                                                                    • StackProps
                                                                                                                                                                      • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                    Index

                                                                                                                                                                    Properties

                                                                                                                                                                    description? +
                                                                                                                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                        description?: string;
                                                                                                                                                                        env?: Environment;
                                                                                                                                                                        stackName?: string;
                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                        pipelineSourceBucket: IBucket;
                                                                                                                                                                        pipelineSourcePrefix?: string;
                                                                                                                                                                        pipelineArtifactBucket: Bucket;
                                                                                                                                                                        pipelineArtifactPrefix?: string;
                                                                                                                                                                        pipelineOutputBucket: Bucket;
                                                                                                                                                                        pipelineOutputPrefix?: string;
                                                                                                                                                                        ecrRepository: IRepository;
                                                                                                                                                                        ecrRepositoryImageTag: string;
                                                                                                                                                                        projectType: ProjectType;
                                                                                                                                                                        vpc: IVpc;
                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                        encryptionKey: Key;
                                                                                                                                                                        sourceCustomPath?: string;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy

                                                                                                                                                                    • StackProps
                                                                                                                                                                      • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                    Index

                                                                                                                                                                    Properties

                                                                                                                                                                    description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                    pipelineSourceBucket: IBucket

                                                                                                                                                                    The pipeline source bucket

                                                                                                                                                                    -
                                                                                                                                                                    pipelineSourcePrefix?: string

                                                                                                                                                                    The pipeline source prefix

                                                                                                                                                                    -
                                                                                                                                                                    pipelineArtifactBucket: Bucket

                                                                                                                                                                    The pipeline artifact bucket to use

                                                                                                                                                                    -
                                                                                                                                                                    pipelineArtifactPrefix?: string

                                                                                                                                                                    The pipeline artifact bucket prefix to use

                                                                                                                                                                    -
                                                                                                                                                                    pipelineOutputBucket: Bucket

                                                                                                                                                                    The pipeline output bucket to use

                                                                                                                                                                    -
                                                                                                                                                                    pipelineOutputPrefix?: string

                                                                                                                                                                    The pipeline output bucket prefix to use

                                                                                                                                                                    -
                                                                                                                                                                    ecrRepository: IRepository

                                                                                                                                                                    ECR Repository where the Build Host Image resides.

                                                                                                                                                                    -
                                                                                                                                                                    ecrRepositoryImageTag: string

                                                                                                                                                                    Tag for the Build Host Image

                                                                                                                                                                    -
                                                                                                                                                                    projectType: ProjectType

                                                                                                                                                                    The type of project being built.

                                                                                                                                                                    -
                                                                                                                                                                    vpc: IVpc

                                                                                                                                                                    VPC where the networking setup resides.

                                                                                                                                                                    -
                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                    Additional policy statements to add to the build project.

                                                                                                                                                                    -
                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                    Additional build environment variables to the build project.

                                                                                                                                                                    -
                                                                                                                                                                    encryptionKey: Key

                                                                                                                                                                    The encryption key use across

                                                                                                                                                                    -
                                                                                                                                                                    sourceCustomPath?: string

                                                                                                                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                    -

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    On This Page

                                                                                                                                                                    Properties
                                                                                                                                                                    +
                                                                                                                                                                    pipelineSourcePrefix?: string

                                                                                                                                                                    The pipeline source prefix

                                                                                                                                                                    +
                                                                                                                                                                    pipelineArtifactBucket: Bucket

                                                                                                                                                                    The pipeline artifact bucket to use

                                                                                                                                                                    +
                                                                                                                                                                    pipelineArtifactPrefix?: string

                                                                                                                                                                    The pipeline artifact bucket prefix to use

                                                                                                                                                                    +
                                                                                                                                                                    pipelineOutputBucket: Bucket

                                                                                                                                                                    The pipeline output bucket to use

                                                                                                                                                                    +
                                                                                                                                                                    pipelineOutputPrefix?: string

                                                                                                                                                                    The pipeline output bucket prefix to use

                                                                                                                                                                    +
                                                                                                                                                                    ecrRepository: IRepository

                                                                                                                                                                    ECR Repository where the Build Host Image resides.

                                                                                                                                                                    +
                                                                                                                                                                    ecrRepositoryImageTag: string

                                                                                                                                                                    Tag for the Build Host Image

                                                                                                                                                                    +
                                                                                                                                                                    projectType: ProjectType

                                                                                                                                                                    The type of project being built.

                                                                                                                                                                    +
                                                                                                                                                                    vpc: IVpc

                                                                                                                                                                    VPC where the networking setup resides.

                                                                                                                                                                    +
                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                    Additional policy statements to add to the build project.

                                                                                                                                                                    +
                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                    Additional build environment variables to the build project.

                                                                                                                                                                    +
                                                                                                                                                                    encryptionKey: Key

                                                                                                                                                                    The encryption key use across

                                                                                                                                                                    +
                                                                                                                                                                    sourceCustomPath?: string

                                                                                                                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                    +

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    On This Page

                                                                                                                                                                    Properties
                                                                                                                                                                    diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index dcf35aa..eacc7a9 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                    aws4embeddedlinux-cdk-lib
                                                                                                                                                                      Preparing search index...

                                                                                                                                                                      Interface PipelineResourcesProps

                                                                                                                                                                      Select options for the PipelineResourcesStack.

                                                                                                                                                                      -
                                                                                                                                                                      interface PipelineResourcesProps {
                                                                                                                                                                          description?: string;
                                                                                                                                                                          env?: Environment;
                                                                                                                                                                          stackName?: string;
                                                                                                                                                                          tags?: { [key: string]: string };
                                                                                                                                                                          notificationArns?: string[];
                                                                                                                                                                          synthesizer?: IStackSynthesizer;
                                                                                                                                                                          terminationProtection?: boolean;
                                                                                                                                                                          analyticsReporting?: boolean;
                                                                                                                                                                          crossRegionReferences?: boolean;
                                                                                                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                          suppressTemplateIndentation?: boolean;
                                                                                                                                                                          propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                          resource_prefix: string;
                                                                                                                                                                          ecrRepositoryName?: string;
                                                                                                                                                                          pipelineArtifactBucketName?: string;
                                                                                                                                                                          pipelineSourceBucketName?: string;
                                                                                                                                                                          pipelineOutputBucketName?: string;
                                                                                                                                                                          loggingBucketName?: string;
                                                                                                                                                                      }

                                                                                                                                                                      Hierarchy

                                                                                                                                                                      • StackProps
                                                                                                                                                                        • PipelineResourcesProps
                                                                                                                                                                      Index

                                                                                                                                                                      Properties

                                                                                                                                                                      description? +
                                                                                                                                                                      interface PipelineResourcesProps {
                                                                                                                                                                          description?: string;
                                                                                                                                                                          env?: Environment;
                                                                                                                                                                          stackName?: string;
                                                                                                                                                                          tags?: { [key: string]: string };
                                                                                                                                                                          notificationArns?: string[];
                                                                                                                                                                          synthesizer?: IStackSynthesizer;
                                                                                                                                                                          terminationProtection?: boolean;
                                                                                                                                                                          analyticsReporting?: boolean;
                                                                                                                                                                          crossRegionReferences?: boolean;
                                                                                                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                          suppressTemplateIndentation?: boolean;
                                                                                                                                                                          propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                          resource_prefix: string;
                                                                                                                                                                          ecrRepositoryName?: string;
                                                                                                                                                                          pipelineArtifactBucketName?: string;
                                                                                                                                                                          pipelineSourceBucketName?: string;
                                                                                                                                                                          pipelineOutputBucketName?: string;
                                                                                                                                                                          loggingBucketName?: string;
                                                                                                                                                                      }

                                                                                                                                                                      Hierarchy

                                                                                                                                                                      • StackProps
                                                                                                                                                                        • PipelineResourcesProps
                                                                                                                                                                      Index

                                                                                                                                                                      Properties

                                                                                                                                                                      description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                      resource_prefix: string

                                                                                                                                                                      The resource prefix

                                                                                                                                                                      -
                                                                                                                                                                      ecrRepositoryName?: string

                                                                                                                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                      -
                                                                                                                                                                      pipelineArtifactBucketName?: string

                                                                                                                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                      -
                                                                                                                                                                      pipelineSourceBucketName?: string

                                                                                                                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                      -
                                                                                                                                                                      pipelineOutputBucketName?: string

                                                                                                                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                      -
                                                                                                                                                                      loggingBucketName?: string

                                                                                                                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                      -

                                                                                                                                                                      Settings

                                                                                                                                                                      Member Visibility

                                                                                                                                                                      On This Page

                                                                                                                                                                      Properties
                                                                                                                                                                      +
                                                                                                                                                                      ecrRepositoryName?: string

                                                                                                                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                      +
                                                                                                                                                                      pipelineArtifactBucketName?: string

                                                                                                                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                      +
                                                                                                                                                                      pipelineSourceBucketName?: string

                                                                                                                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                      +
                                                                                                                                                                      pipelineOutputBucketName?: string

                                                                                                                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                      +
                                                                                                                                                                      loggingBucketName?: string

                                                                                                                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                      +

                                                                                                                                                                      Settings

                                                                                                                                                                      Member Visibility

                                                                                                                                                                      On This Page

                                                                                                                                                                      Properties
                                                                                                                                                                      From b6c0fc9b3ee845f331a14f26e0fdcffb06fbd816 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 1 Sep 2025 10:10:00 +0000 Subject: [PATCH 44/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@7a92d292f86247c47d4b03e284?= =?UTF-8?q?f4ea5de2d793eb=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 6639092..ba60d61 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                      aws4embeddedlinux-cdk-lib
                                                                                                                                                                        Preparing search index...

                                                                                                                                                                        Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                        The stack for creating a build pipeline.

                                                                                                                                                                        See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                        -

                                                                                                                                                                        Hierarchy

                                                                                                                                                                        • Stack
                                                                                                                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                        Index

                                                                                                                                                                        Constructors

                                                                                                                                                                        constructor +

                                                                                                                                                                        Hierarchy

                                                                                                                                                                        • Stack
                                                                                                                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                        Index

                                                                                                                                                                        Constructors

                                                                                                                                                                        constructor

                                                                                                                                                                        Properties

                                                                                                                                                                        tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                        Constructors

                                                                                                                                                                        Properties

                                                                                                                                                                        tags: TagManager

                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                        +

                                                                                                                                                                        Constructors

                                                                                                                                                                        Properties

                                                                                                                                                                        tags: TagManager

                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                        templateOptions: ITemplateOptions

                                                                                                                                                                        Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                        region: string

                                                                                                                                                                        The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                        This value is resolved according to the following rules:

                                                                                                                                                                        diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index f4e5141..06520df 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                        aws4embeddedlinux-cdk-lib
                                                                                                                                                                          Preparing search index...

                                                                                                                                                                          Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                          The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                          For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                          -

                                                                                                                                                                          Hierarchy

                                                                                                                                                                          • Stack
                                                                                                                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                          Index

                                                                                                                                                                          Constructors

                                                                                                                                                                          constructor +

                                                                                                                                                                          Hierarchy

                                                                                                                                                                          • Stack
                                                                                                                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                          Index

                                                                                                                                                                          Constructors

                                                                                                                                                                          constructor

                                                                                                                                                                          Properties

                                                                                                                                                                          tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                          Constructors

                                                                                                                                                                          Properties

                                                                                                                                                                          tags: TagManager

                                                                                                                                                                          Tags to be applied to the stack.

                                                                                                                                                                          +

                                                                                                                                                                          Constructors

                                                                                                                                                                          Properties

                                                                                                                                                                          tags: TagManager

                                                                                                                                                                          Tags to be applied to the stack.

                                                                                                                                                                          templateOptions: ITemplateOptions

                                                                                                                                                                          Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                          region: string

                                                                                                                                                                          The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                          This value is resolved according to the following rules:

                                                                                                                                                                          @@ -112,8 +112,8 @@

                                                                                                                                                                          Readonly Internal_crossRegionReferences

                                                                                                                                                                          _crossRegionReferences: boolean

                                                                                                                                                                          Whether cross region references are enabled for this stack

                                                                                                                                                                          Optional Readonly Internal_notificationArns

                                                                                                                                                                          _notificationArns?: string[]

                                                                                                                                                                          SNS Notification ARNs to receive stack events.

                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                          The ECR Repository where the image is located.

                                                                                                                                                                          -
                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                          The ECR Image Tag to find the base imaged.

                                                                                                                                                                          -
                                                                                                                                                                          node: Node

                                                                                                                                                                          The tree node.

                                                                                                                                                                          +
                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                          The ECR Image Tag to find the base imaged.

                                                                                                                                                                          +
                                                                                                                                                                          node: Node

                                                                                                                                                                          The tree node.

                                                                                                                                                                          Accessors

                                                                                                                                                                          • get terminationProtection(): boolean

                                                                                                                                                                            Whether termination protection is enabled for this stack.

                                                                                                                                                                            Returns boolean

                                                                                                                                                                          • set terminationProtection(value: boolean): void

                                                                                                                                                                            Parameters

                                                                                                                                                                            • value: boolean

                                                                                                                                                                            Returns void

                                                                                                                                                                          • get dependencies(): Stack[]

                                                                                                                                                                            Return the stacks this stack depends on

                                                                                                                                                                            Returns Stack[]

                                                                                                                                                                          pipelineSourcePrefix?: string

                                                                                                                                                                          The pipeline source prefix

                                                                                                                                                                          +
                                                                                                                                                                          pipelineArtifactBucket: Bucket

                                                                                                                                                                          Artifact bucket to use

                                                                                                                                                                          +
                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                          The ECR Repository to push to.

                                                                                                                                                                          +
                                                                                                                                                                          encryptionKey: Key

                                                                                                                                                                          The encryption key use across

                                                                                                                                                                          +

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility

                                                                                                                                                                          On This Page

                                                                                                                                                                          Properties
                                                                                                                                                                          diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 10f1262..b03b075 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                          aws4embeddedlinux-cdk-lib
                                                                                                                                                                            Preparing search index...

                                                                                                                                                                            Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                            Properties to allow customizing the build.

                                                                                                                                                                            -
                                                                                                                                                                            interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                description?: string;
                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                pipelineSourceBucket: IBucket;
                                                                                                                                                                                pipelineSourcePrefix?: string;
                                                                                                                                                                                pipelineArtifactBucket: Bucket;
                                                                                                                                                                                pipelineArtifactPrefix?: string;
                                                                                                                                                                                pipelineOutputBucket: Bucket;
                                                                                                                                                                                pipelineOutputPrefix?: string;
                                                                                                                                                                                ecrRepository: IRepository;
                                                                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                                                                projectType: ProjectType;
                                                                                                                                                                                vpc: IVpc;
                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                encryptionKey: Key;
                                                                                                                                                                                sourceCustomPath?: string;
                                                                                                                                                                            }

                                                                                                                                                                            Hierarchy

                                                                                                                                                                            • StackProps
                                                                                                                                                                              • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                            Index

                                                                                                                                                                            Properties

                                                                                                                                                                            description? +
                                                                                                                                                                            interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                description?: string;
                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                pipelineSourceBucket: IBucket;
                                                                                                                                                                                pipelineSourcePrefix?: string;
                                                                                                                                                                                pipelineArtifactBucket: Bucket;
                                                                                                                                                                                pipelineArtifactPrefix?: string;
                                                                                                                                                                                pipelineOutputBucket: Bucket;
                                                                                                                                                                                pipelineOutputPrefix?: string;
                                                                                                                                                                                ecrRepository: IRepository;
                                                                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                                                                projectType: ProjectType;
                                                                                                                                                                                vpc: IVpc;
                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                encryptionKey: Key;
                                                                                                                                                                                sourceCustomPath?: string;
                                                                                                                                                                            }

                                                                                                                                                                            Hierarchy

                                                                                                                                                                            • StackProps
                                                                                                                                                                              • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                            Index

                                                                                                                                                                            Properties

                                                                                                                                                                            description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                            pipelineSourceBucket: IBucket

                                                                                                                                                                            The pipeline source bucket

                                                                                                                                                                            -
                                                                                                                                                                            pipelineSourcePrefix?: string

                                                                                                                                                                            The pipeline source prefix

                                                                                                                                                                            -
                                                                                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                                                                                            The pipeline artifact bucket to use

                                                                                                                                                                            -
                                                                                                                                                                            pipelineArtifactPrefix?: string

                                                                                                                                                                            The pipeline artifact bucket prefix to use

                                                                                                                                                                            -
                                                                                                                                                                            pipelineOutputBucket: Bucket

                                                                                                                                                                            The pipeline output bucket to use

                                                                                                                                                                            -
                                                                                                                                                                            pipelineOutputPrefix?: string

                                                                                                                                                                            The pipeline output bucket prefix to use

                                                                                                                                                                            -
                                                                                                                                                                            ecrRepository: IRepository

                                                                                                                                                                            ECR Repository where the Build Host Image resides.

                                                                                                                                                                            -
                                                                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                                                                            Tag for the Build Host Image

                                                                                                                                                                            -
                                                                                                                                                                            projectType: ProjectType

                                                                                                                                                                            The type of project being built.

                                                                                                                                                                            -
                                                                                                                                                                            vpc: IVpc

                                                                                                                                                                            VPC where the networking setup resides.

                                                                                                                                                                            -
                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                                                                            -
                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                            Additional build environment variables to the build project.

                                                                                                                                                                            -
                                                                                                                                                                            encryptionKey: Key

                                                                                                                                                                            The encryption key use across

                                                                                                                                                                            -
                                                                                                                                                                            sourceCustomPath?: string

                                                                                                                                                                            Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                            -

                                                                                                                                                                            Settings

                                                                                                                                                                            Member Visibility

                                                                                                                                                                            On This Page

                                                                                                                                                                            Properties
                                                                                                                                                                            +
                                                                                                                                                                            pipelineSourcePrefix?: string

                                                                                                                                                                            The pipeline source prefix

                                                                                                                                                                            +
                                                                                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                                                                                            The pipeline artifact bucket to use

                                                                                                                                                                            +
                                                                                                                                                                            pipelineArtifactPrefix?: string

                                                                                                                                                                            The pipeline artifact bucket prefix to use

                                                                                                                                                                            +
                                                                                                                                                                            pipelineOutputBucket: Bucket

                                                                                                                                                                            The pipeline output bucket to use

                                                                                                                                                                            +
                                                                                                                                                                            pipelineOutputPrefix?: string

                                                                                                                                                                            The pipeline output bucket prefix to use

                                                                                                                                                                            +
                                                                                                                                                                            ecrRepository: IRepository

                                                                                                                                                                            ECR Repository where the Build Host Image resides.

                                                                                                                                                                            +
                                                                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                                                                            Tag for the Build Host Image

                                                                                                                                                                            +
                                                                                                                                                                            projectType: ProjectType

                                                                                                                                                                            The type of project being built.

                                                                                                                                                                            +
                                                                                                                                                                            vpc: IVpc

                                                                                                                                                                            VPC where the networking setup resides.

                                                                                                                                                                            +
                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                                                                            +
                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                            Additional build environment variables to the build project.

                                                                                                                                                                            +
                                                                                                                                                                            encryptionKey: Key

                                                                                                                                                                            The encryption key use across

                                                                                                                                                                            +
                                                                                                                                                                            sourceCustomPath?: string

                                                                                                                                                                            Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                            +

                                                                                                                                                                            Settings

                                                                                                                                                                            Member Visibility

                                                                                                                                                                            On This Page

                                                                                                                                                                            Properties
                                                                                                                                                                            diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index eacc7a9..f0dcb23 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                            aws4embeddedlinux-cdk-lib
                                                                                                                                                                              Preparing search index...

                                                                                                                                                                              Interface PipelineResourcesProps

                                                                                                                                                                              Select options for the PipelineResourcesStack.

                                                                                                                                                                              -
                                                                                                                                                                              interface PipelineResourcesProps {
                                                                                                                                                                                  description?: string;
                                                                                                                                                                                  env?: Environment;
                                                                                                                                                                                  stackName?: string;
                                                                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                                                                  notificationArns?: string[];
                                                                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                  resource_prefix: string;
                                                                                                                                                                                  ecrRepositoryName?: string;
                                                                                                                                                                                  pipelineArtifactBucketName?: string;
                                                                                                                                                                                  pipelineSourceBucketName?: string;
                                                                                                                                                                                  pipelineOutputBucketName?: string;
                                                                                                                                                                                  loggingBucketName?: string;
                                                                                                                                                                              }

                                                                                                                                                                              Hierarchy

                                                                                                                                                                              • StackProps
                                                                                                                                                                                • PipelineResourcesProps
                                                                                                                                                                              Index

                                                                                                                                                                              Properties

                                                                                                                                                                              description? +
                                                                                                                                                                              interface PipelineResourcesProps {
                                                                                                                                                                                  description?: string;
                                                                                                                                                                                  env?: Environment;
                                                                                                                                                                                  stackName?: string;
                                                                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                                                                  notificationArns?: string[];
                                                                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                  resource_prefix: string;
                                                                                                                                                                                  ecrRepositoryName?: string;
                                                                                                                                                                                  pipelineArtifactBucketName?: string;
                                                                                                                                                                                  pipelineSourceBucketName?: string;
                                                                                                                                                                                  pipelineOutputBucketName?: string;
                                                                                                                                                                                  loggingBucketName?: string;
                                                                                                                                                                              }

                                                                                                                                                                              Hierarchy

                                                                                                                                                                              • StackProps
                                                                                                                                                                                • PipelineResourcesProps
                                                                                                                                                                              Index

                                                                                                                                                                              Properties

                                                                                                                                                                              description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                              resource_prefix: string

                                                                                                                                                                              The resource prefix

                                                                                                                                                                              -
                                                                                                                                                                              ecrRepositoryName?: string

                                                                                                                                                                              The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                              -
                                                                                                                                                                              pipelineArtifactBucketName?: string

                                                                                                                                                                              The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                              -
                                                                                                                                                                              pipelineSourceBucketName?: string

                                                                                                                                                                              The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                              -
                                                                                                                                                                              pipelineOutputBucketName?: string

                                                                                                                                                                              The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                              -
                                                                                                                                                                              loggingBucketName?: string

                                                                                                                                                                              Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                              -

                                                                                                                                                                              Settings

                                                                                                                                                                              Member Visibility

                                                                                                                                                                              On This Page

                                                                                                                                                                              Properties
                                                                                                                                                                              +
                                                                                                                                                                              ecrRepositoryName?: string

                                                                                                                                                                              The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                              +
                                                                                                                                                                              pipelineArtifactBucketName?: string

                                                                                                                                                                              The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                              +
                                                                                                                                                                              pipelineSourceBucketName?: string

                                                                                                                                                                              The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                              +
                                                                                                                                                                              pipelineOutputBucketName?: string

                                                                                                                                                                              The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                              +
                                                                                                                                                                              loggingBucketName?: string

                                                                                                                                                                              Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                              +

                                                                                                                                                                              Settings

                                                                                                                                                                              Member Visibility

                                                                                                                                                                              On This Page

                                                                                                                                                                              Properties
                                                                                                                                                                              From 046a563edd529eeeffcbc1d74bf4c1e783acd755 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 2 Sep 2025 07:35:49 +0000 Subject: [PATCH 45/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@2423bb5eb153cef5e2cba684e1?= =?UTF-8?q?43c4912464db0a=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index ba60d61..df4d83e 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                The stack for creating a build pipeline.

                                                                                                                                                                                See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                -

                                                                                                                                                                                Hierarchy

                                                                                                                                                                                • Stack
                                                                                                                                                                                  • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                Index

                                                                                                                                                                                Constructors

                                                                                                                                                                                constructor +

                                                                                                                                                                                Hierarchy

                                                                                                                                                                                • Stack
                                                                                                                                                                                  • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                Index

                                                                                                                                                                                Constructors

                                                                                                                                                                                constructor

                                                                                                                                                                                Properties

                                                                                                                                                                                tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                Constructors

                                                                                                                                                                                Properties

                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                +

                                                                                                                                                                                Constructors

                                                                                                                                                                                Properties

                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                templateOptions: ITemplateOptions

                                                                                                                                                                                Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                region: string

                                                                                                                                                                                The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                This value is resolved according to the following rules:

                                                                                                                                                                                diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 06520df..e684d4c 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                  Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                  The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                  For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                  -

                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                  • Stack
                                                                                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                  Index

                                                                                                                                                                                  Constructors

                                                                                                                                                                                  constructor +

                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                  • Stack
                                                                                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                  Index

                                                                                                                                                                                  Constructors

                                                                                                                                                                                  constructor

                                                                                                                                                                                  Properties

                                                                                                                                                                                  tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                  Constructors

                                                                                                                                                                                  Properties

                                                                                                                                                                                  tags: TagManager

                                                                                                                                                                                  Tags to be applied to the stack.

                                                                                                                                                                                  +

                                                                                                                                                                                  Constructors

                                                                                                                                                                                  Properties

                                                                                                                                                                                  tags: TagManager

                                                                                                                                                                                  Tags to be applied to the stack.

                                                                                                                                                                                  templateOptions: ITemplateOptions

                                                                                                                                                                                  Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                  region: string

                                                                                                                                                                                  The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                  This value is resolved according to the following rules:

                                                                                                                                                                                  @@ -112,8 +112,8 @@

                                                                                                                                                                                  Readonly Internal_crossRegionReferences

                                                                                                                                                                                  _crossRegionReferences: boolean

                                                                                                                                                                                  Whether cross region references are enabled for this stack

                                                                                                                                                                                  Optional Readonly Internal_notificationArns

                                                                                                                                                                                  _notificationArns?: string[]

                                                                                                                                                                                  SNS Notification ARNs to receive stack events.

                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                  The ECR Repository where the image is located.

                                                                                                                                                                                  -
                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                  The ECR Image Tag to find the base imaged.

                                                                                                                                                                                  -
                                                                                                                                                                                  node: Node

                                                                                                                                                                                  The tree node.

                                                                                                                                                                                  +
                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                  The ECR Image Tag to find the base imaged.

                                                                                                                                                                                  +
                                                                                                                                                                                  node: Node

                                                                                                                                                                                  The tree node.

                                                                                                                                                                                  Accessors

                                                                                                                                                                                  • get terminationProtection(): boolean

                                                                                                                                                                                    Whether termination protection is enabled for this stack.

                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                  • set terminationProtection(value: boolean): void

                                                                                                                                                                                    Parameters

                                                                                                                                                                                    • value: boolean

                                                                                                                                                                                    Returns void

                                                                                                                                                                                  • get dependencies(): Stack[]

                                                                                                                                                                                    Return the stacks this stack depends on

                                                                                                                                                                                    Returns Stack[]

                                                                                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                                                                                  The pipeline source prefix

                                                                                                                                                                                  +
                                                                                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                                                                                  Artifact bucket to use

                                                                                                                                                                                  +
                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                  The ECR Repository to push to.

                                                                                                                                                                                  +
                                                                                                                                                                                  encryptionKey: Key

                                                                                                                                                                                  The encryption key use across

                                                                                                                                                                                  +

                                                                                                                                                                                  Settings

                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                  On This Page

                                                                                                                                                                                  Properties
                                                                                                                                                                                  diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index b03b075..35fd0e7 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                    Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                    Properties to allow customizing the build.

                                                                                                                                                                                    -
                                                                                                                                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                        description?: string;
                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                        pipelineSourceBucket: IBucket;
                                                                                                                                                                                        pipelineSourcePrefix?: string;
                                                                                                                                                                                        pipelineArtifactBucket: Bucket;
                                                                                                                                                                                        pipelineArtifactPrefix?: string;
                                                                                                                                                                                        pipelineOutputBucket: Bucket;
                                                                                                                                                                                        pipelineOutputPrefix?: string;
                                                                                                                                                                                        ecrRepository: IRepository;
                                                                                                                                                                                        ecrRepositoryImageTag: string;
                                                                                                                                                                                        projectType: ProjectType;
                                                                                                                                                                                        vpc: IVpc;
                                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                        encryptionKey: Key;
                                                                                                                                                                                        sourceCustomPath?: string;
                                                                                                                                                                                    }

                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                    • StackProps
                                                                                                                                                                                      • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                    Index

                                                                                                                                                                                    Properties

                                                                                                                                                                                    description? +
                                                                                                                                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                        description?: string;
                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                        pipelineSourceBucket: IBucket;
                                                                                                                                                                                        pipelineSourcePrefix?: string;
                                                                                                                                                                                        pipelineArtifactBucket: Bucket;
                                                                                                                                                                                        pipelineArtifactPrefix?: string;
                                                                                                                                                                                        pipelineOutputBucket: Bucket;
                                                                                                                                                                                        pipelineOutputPrefix?: string;
                                                                                                                                                                                        ecrRepository: IRepository;
                                                                                                                                                                                        ecrRepositoryImageTag: string;
                                                                                                                                                                                        projectType: ProjectType;
                                                                                                                                                                                        vpc: IVpc;
                                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                        encryptionKey: Key;
                                                                                                                                                                                        sourceCustomPath?: string;
                                                                                                                                                                                    }

                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                    • StackProps
                                                                                                                                                                                      • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                    Index

                                                                                                                                                                                    Properties

                                                                                                                                                                                    description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                    pipelineSourceBucket: IBucket

                                                                                                                                                                                    The pipeline source bucket

                                                                                                                                                                                    -
                                                                                                                                                                                    pipelineSourcePrefix?: string

                                                                                                                                                                                    The pipeline source prefix

                                                                                                                                                                                    -
                                                                                                                                                                                    pipelineArtifactBucket: Bucket

                                                                                                                                                                                    The pipeline artifact bucket to use

                                                                                                                                                                                    -
                                                                                                                                                                                    pipelineArtifactPrefix?: string

                                                                                                                                                                                    The pipeline artifact bucket prefix to use

                                                                                                                                                                                    -
                                                                                                                                                                                    pipelineOutputBucket: Bucket

                                                                                                                                                                                    The pipeline output bucket to use

                                                                                                                                                                                    -
                                                                                                                                                                                    pipelineOutputPrefix?: string

                                                                                                                                                                                    The pipeline output bucket prefix to use

                                                                                                                                                                                    -
                                                                                                                                                                                    ecrRepository: IRepository

                                                                                                                                                                                    ECR Repository where the Build Host Image resides.

                                                                                                                                                                                    -
                                                                                                                                                                                    ecrRepositoryImageTag: string

                                                                                                                                                                                    Tag for the Build Host Image

                                                                                                                                                                                    -
                                                                                                                                                                                    projectType: ProjectType

                                                                                                                                                                                    The type of project being built.

                                                                                                                                                                                    -
                                                                                                                                                                                    vpc: IVpc

                                                                                                                                                                                    VPC where the networking setup resides.

                                                                                                                                                                                    -
                                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                    Additional policy statements to add to the build project.

                                                                                                                                                                                    -
                                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                    Additional build environment variables to the build project.

                                                                                                                                                                                    -
                                                                                                                                                                                    encryptionKey: Key

                                                                                                                                                                                    The encryption key use across

                                                                                                                                                                                    -
                                                                                                                                                                                    sourceCustomPath?: string

                                                                                                                                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                    -

                                                                                                                                                                                    Settings

                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                    On This Page

                                                                                                                                                                                    Properties
                                                                                                                                                                                    +
                                                                                                                                                                                    pipelineSourcePrefix?: string

                                                                                                                                                                                    The pipeline source prefix

                                                                                                                                                                                    +
                                                                                                                                                                                    pipelineArtifactBucket: Bucket

                                                                                                                                                                                    The pipeline artifact bucket to use

                                                                                                                                                                                    +
                                                                                                                                                                                    pipelineArtifactPrefix?: string

                                                                                                                                                                                    The pipeline artifact bucket prefix to use

                                                                                                                                                                                    +
                                                                                                                                                                                    pipelineOutputBucket: Bucket

                                                                                                                                                                                    The pipeline output bucket to use

                                                                                                                                                                                    +
                                                                                                                                                                                    pipelineOutputPrefix?: string

                                                                                                                                                                                    The pipeline output bucket prefix to use

                                                                                                                                                                                    +
                                                                                                                                                                                    ecrRepository: IRepository

                                                                                                                                                                                    ECR Repository where the Build Host Image resides.

                                                                                                                                                                                    +
                                                                                                                                                                                    ecrRepositoryImageTag: string

                                                                                                                                                                                    Tag for the Build Host Image

                                                                                                                                                                                    +
                                                                                                                                                                                    projectType: ProjectType

                                                                                                                                                                                    The type of project being built.

                                                                                                                                                                                    +
                                                                                                                                                                                    vpc: IVpc

                                                                                                                                                                                    VPC where the networking setup resides.

                                                                                                                                                                                    +
                                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                    Additional policy statements to add to the build project.

                                                                                                                                                                                    +
                                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                    Additional build environment variables to the build project.

                                                                                                                                                                                    +
                                                                                                                                                                                    encryptionKey: Key

                                                                                                                                                                                    The encryption key use across

                                                                                                                                                                                    +
                                                                                                                                                                                    sourceCustomPath?: string

                                                                                                                                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                    +

                                                                                                                                                                                    Settings

                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                    On This Page

                                                                                                                                                                                    Properties
                                                                                                                                                                                    diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index f0dcb23..540b8b7 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                    aws4embeddedlinux-cdk-lib
                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                      Interface PipelineResourcesProps

                                                                                                                                                                                      Select options for the PipelineResourcesStack.

                                                                                                                                                                                      -
                                                                                                                                                                                      interface PipelineResourcesProps {
                                                                                                                                                                                          description?: string;
                                                                                                                                                                                          env?: Environment;
                                                                                                                                                                                          stackName?: string;
                                                                                                                                                                                          tags?: { [key: string]: string };
                                                                                                                                                                                          notificationArns?: string[];
                                                                                                                                                                                          synthesizer?: IStackSynthesizer;
                                                                                                                                                                                          terminationProtection?: boolean;
                                                                                                                                                                                          analyticsReporting?: boolean;
                                                                                                                                                                                          crossRegionReferences?: boolean;
                                                                                                                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                          suppressTemplateIndentation?: boolean;
                                                                                                                                                                                          propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                          resource_prefix: string;
                                                                                                                                                                                          ecrRepositoryName?: string;
                                                                                                                                                                                          pipelineArtifactBucketName?: string;
                                                                                                                                                                                          pipelineSourceBucketName?: string;
                                                                                                                                                                                          pipelineOutputBucketName?: string;
                                                                                                                                                                                          loggingBucketName?: string;
                                                                                                                                                                                      }

                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                      • StackProps
                                                                                                                                                                                        • PipelineResourcesProps
                                                                                                                                                                                      Index

                                                                                                                                                                                      Properties

                                                                                                                                                                                      description? +
                                                                                                                                                                                      interface PipelineResourcesProps {
                                                                                                                                                                                          description?: string;
                                                                                                                                                                                          env?: Environment;
                                                                                                                                                                                          stackName?: string;
                                                                                                                                                                                          tags?: { [key: string]: string };
                                                                                                                                                                                          notificationArns?: string[];
                                                                                                                                                                                          synthesizer?: IStackSynthesizer;
                                                                                                                                                                                          terminationProtection?: boolean;
                                                                                                                                                                                          analyticsReporting?: boolean;
                                                                                                                                                                                          crossRegionReferences?: boolean;
                                                                                                                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                          suppressTemplateIndentation?: boolean;
                                                                                                                                                                                          propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                          resource_prefix: string;
                                                                                                                                                                                          ecrRepositoryName?: string;
                                                                                                                                                                                          pipelineArtifactBucketName?: string;
                                                                                                                                                                                          pipelineSourceBucketName?: string;
                                                                                                                                                                                          pipelineOutputBucketName?: string;
                                                                                                                                                                                          loggingBucketName?: string;
                                                                                                                                                                                      }

                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                      • StackProps
                                                                                                                                                                                        • PipelineResourcesProps
                                                                                                                                                                                      Index

                                                                                                                                                                                      Properties

                                                                                                                                                                                      description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                      resource_prefix: string

                                                                                                                                                                                      The resource prefix

                                                                                                                                                                                      -
                                                                                                                                                                                      ecrRepositoryName?: string

                                                                                                                                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                      -
                                                                                                                                                                                      pipelineArtifactBucketName?: string

                                                                                                                                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                      -
                                                                                                                                                                                      pipelineSourceBucketName?: string

                                                                                                                                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                      -
                                                                                                                                                                                      pipelineOutputBucketName?: string

                                                                                                                                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                      -
                                                                                                                                                                                      loggingBucketName?: string

                                                                                                                                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                      -

                                                                                                                                                                                      Settings

                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                      On This Page

                                                                                                                                                                                      Properties
                                                                                                                                                                                      +
                                                                                                                                                                                      ecrRepositoryName?: string

                                                                                                                                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                      +
                                                                                                                                                                                      pipelineArtifactBucketName?: string

                                                                                                                                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                      +
                                                                                                                                                                                      pipelineSourceBucketName?: string

                                                                                                                                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                      +
                                                                                                                                                                                      pipelineOutputBucketName?: string

                                                                                                                                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                      +
                                                                                                                                                                                      loggingBucketName?: string

                                                                                                                                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                      +

                                                                                                                                                                                      Settings

                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                      On This Page

                                                                                                                                                                                      Properties
                                                                                                                                                                                      From b535112e5822b730e637cd644aeb508b93f70456 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 2 Sep 2025 07:36:14 +0000 Subject: [PATCH 46/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@beba26af727b8bec4c96409329?= =?UTF-8?q?7d368a9826dc9e=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index df4d83e..dc0625a 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                      aws4embeddedlinux-cdk-lib
                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                        Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                        The stack for creating a build pipeline.

                                                                                                                                                                                        See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                        -

                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                        • Stack
                                                                                                                                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                        Index

                                                                                                                                                                                        Constructors

                                                                                                                                                                                        constructor +

                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                        • Stack
                                                                                                                                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                        Index

                                                                                                                                                                                        Constructors

                                                                                                                                                                                        constructor

                                                                                                                                                                                        Properties

                                                                                                                                                                                        tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                        Constructors

                                                                                                                                                                                        Properties

                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                        +

                                                                                                                                                                                        Constructors

                                                                                                                                                                                        Properties

                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                        templateOptions: ITemplateOptions

                                                                                                                                                                                        Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                        region: string

                                                                                                                                                                                        The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                        This value is resolved according to the following rules:

                                                                                                                                                                                        diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index e684d4c..4c2f946 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                        aws4embeddedlinux-cdk-lib
                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                          Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                          The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                          For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                          -

                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                          • Stack
                                                                                                                                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                          Index

                                                                                                                                                                                          Constructors

                                                                                                                                                                                          constructor +

                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                          • Stack
                                                                                                                                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                          Index

                                                                                                                                                                                          Constructors

                                                                                                                                                                                          constructor

                                                                                                                                                                                          Properties

                                                                                                                                                                                          tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                          Constructors

                                                                                                                                                                                          Properties

                                                                                                                                                                                          tags: TagManager

                                                                                                                                                                                          Tags to be applied to the stack.

                                                                                                                                                                                          +

                                                                                                                                                                                          Constructors

                                                                                                                                                                                          Properties

                                                                                                                                                                                          tags: TagManager

                                                                                                                                                                                          Tags to be applied to the stack.

                                                                                                                                                                                          templateOptions: ITemplateOptions

                                                                                                                                                                                          Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                          region: string

                                                                                                                                                                                          The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                          This value is resolved according to the following rules:

                                                                                                                                                                                          @@ -112,8 +112,8 @@

                                                                                                                                                                                          Readonly Internal_crossRegionReferences

                                                                                                                                                                                          _crossRegionReferences: boolean

                                                                                                                                                                                          Whether cross region references are enabled for this stack

                                                                                                                                                                                          Optional Readonly Internal_notificationArns

                                                                                                                                                                                          _notificationArns?: string[]

                                                                                                                                                                                          SNS Notification ARNs to receive stack events.

                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                          The ECR Repository where the image is located.

                                                                                                                                                                                          -
                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                          The ECR Image Tag to find the base imaged.

                                                                                                                                                                                          -
                                                                                                                                                                                          node: Node

                                                                                                                                                                                          The tree node.

                                                                                                                                                                                          +
                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                          The ECR Image Tag to find the base imaged.

                                                                                                                                                                                          +
                                                                                                                                                                                          node: Node

                                                                                                                                                                                          The tree node.

                                                                                                                                                                                          Accessors

                                                                                                                                                                                          • get terminationProtection(): boolean

                                                                                                                                                                                            Whether termination protection is enabled for this stack.

                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                          • set terminationProtection(value: boolean): void

                                                                                                                                                                                            Parameters

                                                                                                                                                                                            • value: boolean

                                                                                                                                                                                            Returns void

                                                                                                                                                                                          • get dependencies(): Stack[]

                                                                                                                                                                                            Return the stacks this stack depends on

                                                                                                                                                                                            Returns Stack[]

                                                                                                                                                                                          pipelineSourcePrefix?: string

                                                                                                                                                                                          The pipeline source prefix

                                                                                                                                                                                          +
                                                                                                                                                                                          pipelineArtifactBucket: Bucket

                                                                                                                                                                                          Artifact bucket to use

                                                                                                                                                                                          +
                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                          The ECR Repository to push to.

                                                                                                                                                                                          +
                                                                                                                                                                                          encryptionKey: Key

                                                                                                                                                                                          The encryption key use across

                                                                                                                                                                                          +

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          Properties
                                                                                                                                                                                          diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 35fd0e7..143e304 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                          aws4embeddedlinux-cdk-lib
                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                            Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                            Properties to allow customizing the build.

                                                                                                                                                                                            -
                                                                                                                                                                                            interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                pipelineSourceBucket: IBucket;
                                                                                                                                                                                                pipelineSourcePrefix?: string;
                                                                                                                                                                                                pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                pipelineArtifactPrefix?: string;
                                                                                                                                                                                                pipelineOutputBucket: Bucket;
                                                                                                                                                                                                pipelineOutputPrefix?: string;
                                                                                                                                                                                                ecrRepository: IRepository;
                                                                                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                                                                                projectType: ProjectType;
                                                                                                                                                                                                vpc: IVpc;
                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                encryptionKey: Key;
                                                                                                                                                                                                sourceCustomPath?: string;
                                                                                                                                                                                            }

                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                            • StackProps
                                                                                                                                                                                              • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                            Index

                                                                                                                                                                                            Properties

                                                                                                                                                                                            description? +
                                                                                                                                                                                            interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                pipelineSourceBucket: IBucket;
                                                                                                                                                                                                pipelineSourcePrefix?: string;
                                                                                                                                                                                                pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                pipelineArtifactPrefix?: string;
                                                                                                                                                                                                pipelineOutputBucket: Bucket;
                                                                                                                                                                                                pipelineOutputPrefix?: string;
                                                                                                                                                                                                ecrRepository: IRepository;
                                                                                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                                                                                projectType: ProjectType;
                                                                                                                                                                                                vpc: IVpc;
                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                encryptionKey: Key;
                                                                                                                                                                                                sourceCustomPath?: string;
                                                                                                                                                                                            }

                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                            • StackProps
                                                                                                                                                                                              • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                            Index

                                                                                                                                                                                            Properties

                                                                                                                                                                                            description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                            pipelineSourceBucket: IBucket

                                                                                                                                                                                            The pipeline source bucket

                                                                                                                                                                                            -
                                                                                                                                                                                            pipelineSourcePrefix?: string

                                                                                                                                                                                            The pipeline source prefix

                                                                                                                                                                                            -
                                                                                                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                                                                                                            The pipeline artifact bucket to use

                                                                                                                                                                                            -
                                                                                                                                                                                            pipelineArtifactPrefix?: string

                                                                                                                                                                                            The pipeline artifact bucket prefix to use

                                                                                                                                                                                            -
                                                                                                                                                                                            pipelineOutputBucket: Bucket

                                                                                                                                                                                            The pipeline output bucket to use

                                                                                                                                                                                            -
                                                                                                                                                                                            pipelineOutputPrefix?: string

                                                                                                                                                                                            The pipeline output bucket prefix to use

                                                                                                                                                                                            -
                                                                                                                                                                                            ecrRepository: IRepository

                                                                                                                                                                                            ECR Repository where the Build Host Image resides.

                                                                                                                                                                                            -
                                                                                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                                                                                            Tag for the Build Host Image

                                                                                                                                                                                            -
                                                                                                                                                                                            projectType: ProjectType

                                                                                                                                                                                            The type of project being built.

                                                                                                                                                                                            -
                                                                                                                                                                                            vpc: IVpc

                                                                                                                                                                                            VPC where the networking setup resides.

                                                                                                                                                                                            -
                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                                                                                            -
                                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                            Additional build environment variables to the build project.

                                                                                                                                                                                            -
                                                                                                                                                                                            encryptionKey: Key

                                                                                                                                                                                            The encryption key use across

                                                                                                                                                                                            -
                                                                                                                                                                                            sourceCustomPath?: string

                                                                                                                                                                                            Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                            -

                                                                                                                                                                                            Settings

                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                            On This Page

                                                                                                                                                                                            Properties
                                                                                                                                                                                            +
                                                                                                                                                                                            pipelineSourcePrefix?: string

                                                                                                                                                                                            The pipeline source prefix

                                                                                                                                                                                            +
                                                                                                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                                                                                                            The pipeline artifact bucket to use

                                                                                                                                                                                            +
                                                                                                                                                                                            pipelineArtifactPrefix?: string

                                                                                                                                                                                            The pipeline artifact bucket prefix to use

                                                                                                                                                                                            +
                                                                                                                                                                                            pipelineOutputBucket: Bucket

                                                                                                                                                                                            The pipeline output bucket to use

                                                                                                                                                                                            +
                                                                                                                                                                                            pipelineOutputPrefix?: string

                                                                                                                                                                                            The pipeline output bucket prefix to use

                                                                                                                                                                                            +
                                                                                                                                                                                            ecrRepository: IRepository

                                                                                                                                                                                            ECR Repository where the Build Host Image resides.

                                                                                                                                                                                            +
                                                                                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                                                                                            Tag for the Build Host Image

                                                                                                                                                                                            +
                                                                                                                                                                                            projectType: ProjectType

                                                                                                                                                                                            The type of project being built.

                                                                                                                                                                                            +
                                                                                                                                                                                            vpc: IVpc

                                                                                                                                                                                            VPC where the networking setup resides.

                                                                                                                                                                                            +
                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                                                                                            +
                                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                            Additional build environment variables to the build project.

                                                                                                                                                                                            +
                                                                                                                                                                                            encryptionKey: Key

                                                                                                                                                                                            The encryption key use across

                                                                                                                                                                                            +
                                                                                                                                                                                            sourceCustomPath?: string

                                                                                                                                                                                            Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                            +

                                                                                                                                                                                            Settings

                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                            On This Page

                                                                                                                                                                                            Properties
                                                                                                                                                                                            diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 540b8b7..2d6148a 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                            aws4embeddedlinux-cdk-lib
                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                              Interface PipelineResourcesProps

                                                                                                                                                                                              Select options for the PipelineResourcesStack.

                                                                                                                                                                                              -
                                                                                                                                                                                              interface PipelineResourcesProps {
                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                  env?: Environment;
                                                                                                                                                                                                  stackName?: string;
                                                                                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                                                                                  notificationArns?: string[];
                                                                                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                  resource_prefix: string;
                                                                                                                                                                                                  ecrRepositoryName?: string;
                                                                                                                                                                                                  pipelineArtifactBucketName?: string;
                                                                                                                                                                                                  pipelineSourceBucketName?: string;
                                                                                                                                                                                                  pipelineOutputBucketName?: string;
                                                                                                                                                                                                  loggingBucketName?: string;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                              • StackProps
                                                                                                                                                                                                • PipelineResourcesProps
                                                                                                                                                                                              Index

                                                                                                                                                                                              Properties

                                                                                                                                                                                              description? +
                                                                                                                                                                                              interface PipelineResourcesProps {
                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                  env?: Environment;
                                                                                                                                                                                                  stackName?: string;
                                                                                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                                                                                  notificationArns?: string[];
                                                                                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                  resource_prefix: string;
                                                                                                                                                                                                  ecrRepositoryName?: string;
                                                                                                                                                                                                  pipelineArtifactBucketName?: string;
                                                                                                                                                                                                  pipelineSourceBucketName?: string;
                                                                                                                                                                                                  pipelineOutputBucketName?: string;
                                                                                                                                                                                                  loggingBucketName?: string;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                              • StackProps
                                                                                                                                                                                                • PipelineResourcesProps
                                                                                                                                                                                              Index

                                                                                                                                                                                              Properties

                                                                                                                                                                                              description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                              resource_prefix: string

                                                                                                                                                                                              The resource prefix

                                                                                                                                                                                              -
                                                                                                                                                                                              ecrRepositoryName?: string

                                                                                                                                                                                              The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                              -
                                                                                                                                                                                              pipelineArtifactBucketName?: string

                                                                                                                                                                                              The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                              -
                                                                                                                                                                                              pipelineSourceBucketName?: string

                                                                                                                                                                                              The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                              -
                                                                                                                                                                                              pipelineOutputBucketName?: string

                                                                                                                                                                                              The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                              -
                                                                                                                                                                                              loggingBucketName?: string

                                                                                                                                                                                              Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                              -

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              Properties
                                                                                                                                                                                              +
                                                                                                                                                                                              ecrRepositoryName?: string

                                                                                                                                                                                              The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                              +
                                                                                                                                                                                              pipelineArtifactBucketName?: string

                                                                                                                                                                                              The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                              +
                                                                                                                                                                                              pipelineSourceBucketName?: string

                                                                                                                                                                                              The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                              +
                                                                                                                                                                                              pipelineOutputBucketName?: string

                                                                                                                                                                                              The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                              +
                                                                                                                                                                                              loggingBucketName?: string

                                                                                                                                                                                              Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                              +

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              Properties
                                                                                                                                                                                              From f0c5adef5f5f9def1b16c14e4b1220c2474b7549 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 2 Sep 2025 09:34:37 +0000 Subject: [PATCH 47/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@9c1dc7afa59f24a70229908e18?= =?UTF-8?q?fdb724d505ffff=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index dc0625a..5b8a02d 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                The stack for creating a build pipeline.

                                                                                                                                                                                                See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                -

                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                • Stack
                                                                                                                                                                                                  • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                Index

                                                                                                                                                                                                Constructors

                                                                                                                                                                                                constructor +

                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                • Stack
                                                                                                                                                                                                  • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                Index

                                                                                                                                                                                                Constructors

                                                                                                                                                                                                constructor

                                                                                                                                                                                                Properties

                                                                                                                                                                                                tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                Constructors

                                                                                                                                                                                                Properties

                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                +

                                                                                                                                                                                                Constructors

                                                                                                                                                                                                Properties

                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                templateOptions: ITemplateOptions

                                                                                                                                                                                                Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                region: string

                                                                                                                                                                                                The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                This value is resolved according to the following rules:

                                                                                                                                                                                                diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 4c2f946..7d994fb 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                  Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                  The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                  For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                  -

                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                  • Stack
                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                  Index

                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                  constructor +

                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                  • Stack
                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                  Index

                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                  constructor

                                                                                                                                                                                                  Properties

                                                                                                                                                                                                  tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                  Properties

                                                                                                                                                                                                  tags: TagManager

                                                                                                                                                                                                  Tags to be applied to the stack.

                                                                                                                                                                                                  +

                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                  Properties

                                                                                                                                                                                                  tags: TagManager

                                                                                                                                                                                                  Tags to be applied to the stack.

                                                                                                                                                                                                  templateOptions: ITemplateOptions

                                                                                                                                                                                                  Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                  region: string

                                                                                                                                                                                                  The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                  This value is resolved according to the following rules:

                                                                                                                                                                                                  @@ -112,8 +112,8 @@

                                                                                                                                                                                                  Readonly Internal_crossRegionReferences

                                                                                                                                                                                                  _crossRegionReferences: boolean

                                                                                                                                                                                                  Whether cross region references are enabled for this stack

                                                                                                                                                                                                  Optional Readonly Internal_notificationArns

                                                                                                                                                                                                  _notificationArns?: string[]

                                                                                                                                                                                                  SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                  The ECR Repository where the image is located.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                  The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  node: Node

                                                                                                                                                                                                  The tree node.

                                                                                                                                                                                                  +
                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                  The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                  +
                                                                                                                                                                                                  node: Node

                                                                                                                                                                                                  The tree node.

                                                                                                                                                                                                  Accessors

                                                                                                                                                                                                  • get terminationProtection(): boolean

                                                                                                                                                                                                    Whether termination protection is enabled for this stack.

                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                  • set terminationProtection(value: boolean): void

                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                    • value: boolean

                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                  • get dependencies(): Stack[]

                                                                                                                                                                                                    Return the stacks this stack depends on

                                                                                                                                                                                                    Returns Stack[]

                                                                                                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                                                                                                  The pipeline source prefix

                                                                                                                                                                                                  +
                                                                                                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                                                                                                  Artifact bucket to use

                                                                                                                                                                                                  +
                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                  The ECR Repository to push to.

                                                                                                                                                                                                  +
                                                                                                                                                                                                  encryptionKey: Key

                                                                                                                                                                                                  The encryption key use across

                                                                                                                                                                                                  +

                                                                                                                                                                                                  Settings

                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                  Properties
                                                                                                                                                                                                  diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 143e304..b8e8c8a 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                    Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                    Properties to allow customizing the build.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                        pipelineSourceBucket: IBucket;
                                                                                                                                                                                                        pipelineSourcePrefix?: string;
                                                                                                                                                                                                        pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                        pipelineArtifactPrefix?: string;
                                                                                                                                                                                                        pipelineOutputBucket: Bucket;
                                                                                                                                                                                                        pipelineOutputPrefix?: string;
                                                                                                                                                                                                        ecrRepository: IRepository;
                                                                                                                                                                                                        ecrRepositoryImageTag: string;
                                                                                                                                                                                                        projectType: ProjectType;
                                                                                                                                                                                                        vpc: IVpc;
                                                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                        encryptionKey: Key;
                                                                                                                                                                                                        sourceCustomPath?: string;
                                                                                                                                                                                                    }

                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                      • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                    Index

                                                                                                                                                                                                    Properties

                                                                                                                                                                                                    description? +
                                                                                                                                                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                        pipelineSourceBucket: IBucket;
                                                                                                                                                                                                        pipelineSourcePrefix?: string;
                                                                                                                                                                                                        pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                        pipelineArtifactPrefix?: string;
                                                                                                                                                                                                        pipelineOutputBucket: Bucket;
                                                                                                                                                                                                        pipelineOutputPrefix?: string;
                                                                                                                                                                                                        ecrRepository: IRepository;
                                                                                                                                                                                                        ecrRepositoryImageTag: string;
                                                                                                                                                                                                        projectType: ProjectType;
                                                                                                                                                                                                        vpc: IVpc;
                                                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                        encryptionKey: Key;
                                                                                                                                                                                                        sourceCustomPath?: string;
                                                                                                                                                                                                    }

                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                      • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                    Index

                                                                                                                                                                                                    Properties

                                                                                                                                                                                                    description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                    pipelineSourceBucket: IBucket

                                                                                                                                                                                                    The pipeline source bucket

                                                                                                                                                                                                    -
                                                                                                                                                                                                    pipelineSourcePrefix?: string

                                                                                                                                                                                                    The pipeline source prefix

                                                                                                                                                                                                    -
                                                                                                                                                                                                    pipelineArtifactBucket: Bucket

                                                                                                                                                                                                    The pipeline artifact bucket to use

                                                                                                                                                                                                    -
                                                                                                                                                                                                    pipelineArtifactPrefix?: string

                                                                                                                                                                                                    The pipeline artifact bucket prefix to use

                                                                                                                                                                                                    -
                                                                                                                                                                                                    pipelineOutputBucket: Bucket

                                                                                                                                                                                                    The pipeline output bucket to use

                                                                                                                                                                                                    -
                                                                                                                                                                                                    pipelineOutputPrefix?: string

                                                                                                                                                                                                    The pipeline output bucket prefix to use

                                                                                                                                                                                                    -
                                                                                                                                                                                                    ecrRepository: IRepository

                                                                                                                                                                                                    ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    ecrRepositoryImageTag: string

                                                                                                                                                                                                    Tag for the Build Host Image

                                                                                                                                                                                                    -
                                                                                                                                                                                                    projectType: ProjectType

                                                                                                                                                                                                    The type of project being built.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    vpc: IVpc

                                                                                                                                                                                                    VPC where the networking setup resides.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                    Additional policy statements to add to the build project.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                    Additional build environment variables to the build project.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    encryptionKey: Key

                                                                                                                                                                                                    The encryption key use across

                                                                                                                                                                                                    -
                                                                                                                                                                                                    sourceCustomPath?: string

                                                                                                                                                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                    -

                                                                                                                                                                                                    Settings

                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                    Properties
                                                                                                                                                                                                    +
                                                                                                                                                                                                    pipelineSourcePrefix?: string

                                                                                                                                                                                                    The pipeline source prefix

                                                                                                                                                                                                    +
                                                                                                                                                                                                    pipelineArtifactBucket: Bucket

                                                                                                                                                                                                    The pipeline artifact bucket to use

                                                                                                                                                                                                    +
                                                                                                                                                                                                    pipelineArtifactPrefix?: string

                                                                                                                                                                                                    The pipeline artifact bucket prefix to use

                                                                                                                                                                                                    +
                                                                                                                                                                                                    pipelineOutputBucket: Bucket

                                                                                                                                                                                                    The pipeline output bucket to use

                                                                                                                                                                                                    +
                                                                                                                                                                                                    pipelineOutputPrefix?: string

                                                                                                                                                                                                    The pipeline output bucket prefix to use

                                                                                                                                                                                                    +
                                                                                                                                                                                                    ecrRepository: IRepository

                                                                                                                                                                                                    ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                    +
                                                                                                                                                                                                    ecrRepositoryImageTag: string

                                                                                                                                                                                                    Tag for the Build Host Image

                                                                                                                                                                                                    +
                                                                                                                                                                                                    projectType: ProjectType

                                                                                                                                                                                                    The type of project being built.

                                                                                                                                                                                                    +
                                                                                                                                                                                                    vpc: IVpc

                                                                                                                                                                                                    VPC where the networking setup resides.

                                                                                                                                                                                                    +
                                                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                    Additional policy statements to add to the build project.

                                                                                                                                                                                                    +
                                                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                    Additional build environment variables to the build project.

                                                                                                                                                                                                    +
                                                                                                                                                                                                    encryptionKey: Key

                                                                                                                                                                                                    The encryption key use across

                                                                                                                                                                                                    +
                                                                                                                                                                                                    sourceCustomPath?: string

                                                                                                                                                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                    +

                                                                                                                                                                                                    Settings

                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                    Properties
                                                                                                                                                                                                    diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 2d6148a..d76b0f2 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                    aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                      Interface PipelineResourcesProps

                                                                                                                                                                                                      Select options for the PipelineResourcesStack.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      interface PipelineResourcesProps {
                                                                                                                                                                                                          description?: string;
                                                                                                                                                                                                          env?: Environment;
                                                                                                                                                                                                          stackName?: string;
                                                                                                                                                                                                          tags?: { [key: string]: string };
                                                                                                                                                                                                          notificationArns?: string[];
                                                                                                                                                                                                          synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                          terminationProtection?: boolean;
                                                                                                                                                                                                          analyticsReporting?: boolean;
                                                                                                                                                                                                          crossRegionReferences?: boolean;
                                                                                                                                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                          suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                          propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                          resource_prefix: string;
                                                                                                                                                                                                          ecrRepositoryName?: string;
                                                                                                                                                                                                          pipelineArtifactBucketName?: string;
                                                                                                                                                                                                          pipelineSourceBucketName?: string;
                                                                                                                                                                                                          pipelineOutputBucketName?: string;
                                                                                                                                                                                                          loggingBucketName?: string;
                                                                                                                                                                                                      }

                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                      • StackProps
                                                                                                                                                                                                        • PipelineResourcesProps
                                                                                                                                                                                                      Index

                                                                                                                                                                                                      Properties

                                                                                                                                                                                                      description? +
                                                                                                                                                                                                      interface PipelineResourcesProps {
                                                                                                                                                                                                          description?: string;
                                                                                                                                                                                                          env?: Environment;
                                                                                                                                                                                                          stackName?: string;
                                                                                                                                                                                                          tags?: { [key: string]: string };
                                                                                                                                                                                                          notificationArns?: string[];
                                                                                                                                                                                                          synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                          terminationProtection?: boolean;
                                                                                                                                                                                                          analyticsReporting?: boolean;
                                                                                                                                                                                                          crossRegionReferences?: boolean;
                                                                                                                                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                          suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                          propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                          resource_prefix: string;
                                                                                                                                                                                                          ecrRepositoryName?: string;
                                                                                                                                                                                                          pipelineArtifactBucketName?: string;
                                                                                                                                                                                                          pipelineSourceBucketName?: string;
                                                                                                                                                                                                          pipelineOutputBucketName?: string;
                                                                                                                                                                                                          loggingBucketName?: string;
                                                                                                                                                                                                      }

                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                      • StackProps
                                                                                                                                                                                                        • PipelineResourcesProps
                                                                                                                                                                                                      Index

                                                                                                                                                                                                      Properties

                                                                                                                                                                                                      description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                      resource_prefix: string

                                                                                                                                                                                                      The resource prefix

                                                                                                                                                                                                      -
                                                                                                                                                                                                      ecrRepositoryName?: string

                                                                                                                                                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                      -
                                                                                                                                                                                                      pipelineArtifactBucketName?: string

                                                                                                                                                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                      -
                                                                                                                                                                                                      pipelineSourceBucketName?: string

                                                                                                                                                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                      -
                                                                                                                                                                                                      pipelineOutputBucketName?: string

                                                                                                                                                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                      -
                                                                                                                                                                                                      loggingBucketName?: string

                                                                                                                                                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                      -

                                                                                                                                                                                                      Settings

                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                      Properties
                                                                                                                                                                                                      +
                                                                                                                                                                                                      ecrRepositoryName?: string

                                                                                                                                                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                      +
                                                                                                                                                                                                      pipelineArtifactBucketName?: string

                                                                                                                                                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                      +
                                                                                                                                                                                                      pipelineSourceBucketName?: string

                                                                                                                                                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                      +
                                                                                                                                                                                                      pipelineOutputBucketName?: string

                                                                                                                                                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                      +
                                                                                                                                                                                                      loggingBucketName?: string

                                                                                                                                                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                      +

                                                                                                                                                                                                      Settings

                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                      Properties
                                                                                                                                                                                                      From b7eda38f9e0f60fcc2de3bb52698cb8d004cd760 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 8 Sep 2025 18:53:02 +0000 Subject: [PATCH 48/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@44a343bba8117565cb73d62649?= =?UTF-8?q?aea0bcb4e7fb8b=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 5b8a02d..a895741 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                      aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                        Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                        The stack for creating a build pipeline.

                                                                                                                                                                                                        See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                        -

                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                        • Stack
                                                                                                                                                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                        Index

                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                        constructor +

                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                        • Stack
                                                                                                                                                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                        Index

                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                        constructor

                                                                                                                                                                                                        Properties

                                                                                                                                                                                                        tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                        Properties

                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                        +

                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                        Properties

                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                        templateOptions: ITemplateOptions

                                                                                                                                                                                                        Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                        region: string

                                                                                                                                                                                                        The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                        This value is resolved according to the following rules:

                                                                                                                                                                                                        diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 7d994fb..f0c114f 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                        aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                          Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                          The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                          For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                          -

                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                          • Stack
                                                                                                                                                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                          Index

                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                          constructor +

                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                          • Stack
                                                                                                                                                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                          Index

                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                          constructor

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          tags: TagManager

                                                                                                                                                                                                          Tags to be applied to the stack.

                                                                                                                                                                                                          +

                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          tags: TagManager

                                                                                                                                                                                                          Tags to be applied to the stack.

                                                                                                                                                                                                          templateOptions: ITemplateOptions

                                                                                                                                                                                                          Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                          region: string

                                                                                                                                                                                                          The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                          This value is resolved according to the following rules:

                                                                                                                                                                                                          @@ -112,8 +112,8 @@

                                                                                                                                                                                                          Readonly Internal_crossRegionReferences

                                                                                                                                                                                                          _crossRegionReferences: boolean

                                                                                                                                                                                                          Whether cross region references are enabled for this stack

                                                                                                                                                                                                          Optional Readonly Internal_notificationArns

                                                                                                                                                                                                          _notificationArns?: string[]

                                                                                                                                                                                                          SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                                          The ECR Repository where the image is located.

                                                                                                                                                                                                          -
                                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                                          The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                          -
                                                                                                                                                                                                          node: Node

                                                                                                                                                                                                          The tree node.

                                                                                                                                                                                                          +
                                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                                          The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                          +
                                                                                                                                                                                                          node: Node

                                                                                                                                                                                                          The tree node.

                                                                                                                                                                                                          Accessors

                                                                                                                                                                                                          • get terminationProtection(): boolean

                                                                                                                                                                                                            Whether termination protection is enabled for this stack.

                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                          • set terminationProtection(value: boolean): void

                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                            • value: boolean

                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                          • get dependencies(): Stack[]

                                                                                                                                                                                                            Return the stacks this stack depends on

                                                                                                                                                                                                            Returns Stack[]

                                                                                                                                                                                                          pipelineSourcePrefix?: string

                                                                                                                                                                                                          The pipeline source prefix

                                                                                                                                                                                                          +
                                                                                                                                                                                                          pipelineArtifactBucket: Bucket

                                                                                                                                                                                                          Artifact bucket to use

                                                                                                                                                                                                          +
                                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                                          The ECR Repository to push to.

                                                                                                                                                                                                          +
                                                                                                                                                                                                          encryptionKey: Key

                                                                                                                                                                                                          The encryption key use across

                                                                                                                                                                                                          +

                                                                                                                                                                                                          Settings

                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                          Properties
                                                                                                                                                                                                          diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index b8e8c8a..d55b243 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                          aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                            Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                            Properties to allow customizing the build.

                                                                                                                                                                                                            -
                                                                                                                                                                                                            interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                pipelineSourcePrefix?: string;
                                                                                                                                                                                                                pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                pipelineOutputPrefix?: string;
                                                                                                                                                                                                                ecrRepository: IRepository;
                                                                                                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                                                                                                projectType: ProjectType;
                                                                                                                                                                                                                vpc: IVpc;
                                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                encryptionKey: Key;
                                                                                                                                                                                                                sourceCustomPath?: string;
                                                                                                                                                                                                            }

                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                              • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            description? +
                                                                                                                                                                                                            interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                pipelineSourcePrefix?: string;
                                                                                                                                                                                                                pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                pipelineOutputPrefix?: string;
                                                                                                                                                                                                                ecrRepository: IRepository;
                                                                                                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                                                                                                projectType: ProjectType;
                                                                                                                                                                                                                vpc: IVpc;
                                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                encryptionKey: Key;
                                                                                                                                                                                                                sourceCustomPath?: string;
                                                                                                                                                                                                            }

                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                              • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                            pipelineSourceBucket: IBucket

                                                                                                                                                                                                            The pipeline source bucket

                                                                                                                                                                                                            -
                                                                                                                                                                                                            pipelineSourcePrefix?: string

                                                                                                                                                                                                            The pipeline source prefix

                                                                                                                                                                                                            -
                                                                                                                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                                                                                                                            The pipeline artifact bucket to use

                                                                                                                                                                                                            -
                                                                                                                                                                                                            pipelineArtifactPrefix?: string

                                                                                                                                                                                                            The pipeline artifact bucket prefix to use

                                                                                                                                                                                                            -
                                                                                                                                                                                                            pipelineOutputBucket: Bucket

                                                                                                                                                                                                            The pipeline output bucket to use

                                                                                                                                                                                                            -
                                                                                                                                                                                                            pipelineOutputPrefix?: string

                                                                                                                                                                                                            The pipeline output bucket prefix to use

                                                                                                                                                                                                            -
                                                                                                                                                                                                            ecrRepository: IRepository

                                                                                                                                                                                                            ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                            -
                                                                                                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                                                                                                            Tag for the Build Host Image

                                                                                                                                                                                                            -
                                                                                                                                                                                                            projectType: ProjectType

                                                                                                                                                                                                            The type of project being built.

                                                                                                                                                                                                            -
                                                                                                                                                                                                            vpc: IVpc

                                                                                                                                                                                                            VPC where the networking setup resides.

                                                                                                                                                                                                            -
                                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                                                                                                            -
                                                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                            Additional build environment variables to the build project.

                                                                                                                                                                                                            -
                                                                                                                                                                                                            encryptionKey: Key

                                                                                                                                                                                                            The encryption key use across

                                                                                                                                                                                                            -
                                                                                                                                                                                                            sourceCustomPath?: string

                                                                                                                                                                                                            Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                            Properties
                                                                                                                                                                                                            +
                                                                                                                                                                                                            pipelineSourcePrefix?: string

                                                                                                                                                                                                            The pipeline source prefix

                                                                                                                                                                                                            +
                                                                                                                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                                                                                                                            The pipeline artifact bucket to use

                                                                                                                                                                                                            +
                                                                                                                                                                                                            pipelineArtifactPrefix?: string

                                                                                                                                                                                                            The pipeline artifact bucket prefix to use

                                                                                                                                                                                                            +
                                                                                                                                                                                                            pipelineOutputBucket: Bucket

                                                                                                                                                                                                            The pipeline output bucket to use

                                                                                                                                                                                                            +
                                                                                                                                                                                                            pipelineOutputPrefix?: string

                                                                                                                                                                                                            The pipeline output bucket prefix to use

                                                                                                                                                                                                            +
                                                                                                                                                                                                            ecrRepository: IRepository

                                                                                                                                                                                                            ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                            +
                                                                                                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                                                                                                            Tag for the Build Host Image

                                                                                                                                                                                                            +
                                                                                                                                                                                                            projectType: ProjectType

                                                                                                                                                                                                            The type of project being built.

                                                                                                                                                                                                            +
                                                                                                                                                                                                            vpc: IVpc

                                                                                                                                                                                                            VPC where the networking setup resides.

                                                                                                                                                                                                            +
                                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                                                                                                            +
                                                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                            Additional build environment variables to the build project.

                                                                                                                                                                                                            +
                                                                                                                                                                                                            encryptionKey: Key

                                                                                                                                                                                                            The encryption key use across

                                                                                                                                                                                                            +
                                                                                                                                                                                                            sourceCustomPath?: string

                                                                                                                                                                                                            Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                            +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                            Properties
                                                                                                                                                                                                            diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index d76b0f2..cf9533e 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                            aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                              Interface PipelineResourcesProps

                                                                                                                                                                                                              Select options for the PipelineResourcesStack.

                                                                                                                                                                                                              -
                                                                                                                                                                                                              interface PipelineResourcesProps {
                                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                                  env?: Environment;
                                                                                                                                                                                                                  stackName?: string;
                                                                                                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                                                                                                  notificationArns?: string[];
                                                                                                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                  resource_prefix: string;
                                                                                                                                                                                                                  ecrRepositoryName?: string;
                                                                                                                                                                                                                  pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                  pipelineSourceBucketName?: string;
                                                                                                                                                                                                                  pipelineOutputBucketName?: string;
                                                                                                                                                                                                                  loggingBucketName?: string;
                                                                                                                                                                                                              }

                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                              • StackProps
                                                                                                                                                                                                                • PipelineResourcesProps
                                                                                                                                                                                                              Index

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              description? +
                                                                                                                                                                                                              interface PipelineResourcesProps {
                                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                                  env?: Environment;
                                                                                                                                                                                                                  stackName?: string;
                                                                                                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                                                                                                  notificationArns?: string[];
                                                                                                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                  resource_prefix: string;
                                                                                                                                                                                                                  ecrRepositoryName?: string;
                                                                                                                                                                                                                  pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                  pipelineSourceBucketName?: string;
                                                                                                                                                                                                                  pipelineOutputBucketName?: string;
                                                                                                                                                                                                                  loggingBucketName?: string;
                                                                                                                                                                                                              }

                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                              • StackProps
                                                                                                                                                                                                                • PipelineResourcesProps
                                                                                                                                                                                                              Index

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                              resource_prefix: string

                                                                                                                                                                                                              The resource prefix

                                                                                                                                                                                                              -
                                                                                                                                                                                                              ecrRepositoryName?: string

                                                                                                                                                                                                              The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                              -
                                                                                                                                                                                                              pipelineArtifactBucketName?: string

                                                                                                                                                                                                              The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                              -
                                                                                                                                                                                                              pipelineSourceBucketName?: string

                                                                                                                                                                                                              The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                              -
                                                                                                                                                                                                              pipelineOutputBucketName?: string

                                                                                                                                                                                                              The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                              -
                                                                                                                                                                                                              loggingBucketName?: string

                                                                                                                                                                                                              Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                              -

                                                                                                                                                                                                              Settings

                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                              Properties
                                                                                                                                                                                                              +
                                                                                                                                                                                                              ecrRepositoryName?: string

                                                                                                                                                                                                              The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                              +
                                                                                                                                                                                                              pipelineArtifactBucketName?: string

                                                                                                                                                                                                              The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                              +
                                                                                                                                                                                                              pipelineSourceBucketName?: string

                                                                                                                                                                                                              The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                              +
                                                                                                                                                                                                              pipelineOutputBucketName?: string

                                                                                                                                                                                                              The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                              +
                                                                                                                                                                                                              loggingBucketName?: string

                                                                                                                                                                                                              Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                              +

                                                                                                                                                                                                              Settings

                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                              Properties
                                                                                                                                                                                                              From d9b7dffc48389885752065c63bfdd770a785fddc Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 8 Sep 2025 19:57:15 +0000 Subject: [PATCH 49/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@5bdc4a8c8c2d50a2e42280bdd1?= =?UTF-8?q?9d3ff19b84425f=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index a895741..96f67ec 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                The stack for creating a build pipeline.

                                                                                                                                                                                                                See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                -

                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                • Stack
                                                                                                                                                                                                                  • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                Index

                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                constructor +

                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                • Stack
                                                                                                                                                                                                                  • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                Index

                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                constructor

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                                +

                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                                templateOptions: ITemplateOptions

                                                                                                                                                                                                                Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                region: string

                                                                                                                                                                                                                The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                This value is resolved according to the following rules:

                                                                                                                                                                                                                diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index f0c114f..1d6a32c 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                  Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                  The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                  For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  • Stack
                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                  constructor +

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  • Stack
                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                  constructor

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  tags: TagManager

                                                                                                                                                                                                                  Tags to be applied to the stack.

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  tags: TagManager

                                                                                                                                                                                                                  Tags to be applied to the stack.

                                                                                                                                                                                                                  templateOptions: ITemplateOptions

                                                                                                                                                                                                                  Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                  region: string

                                                                                                                                                                                                                  The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                  This value is resolved according to the following rules:

                                                                                                                                                                                                                  @@ -112,8 +112,8 @@

                                                                                                                                                                                                                  Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                  _crossRegionReferences: boolean

                                                                                                                                                                                                                  Whether cross region references are enabled for this stack

                                                                                                                                                                                                                  Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                  _notificationArns?: string[]

                                                                                                                                                                                                                  SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                  The ECR Repository where the image is located.

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                  The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  node: Node

                                                                                                                                                                                                                  The tree node.

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                  The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  node: Node

                                                                                                                                                                                                                  The tree node.

                                                                                                                                                                                                                  Accessors

                                                                                                                                                                                                                  • get terminationProtection(): boolean

                                                                                                                                                                                                                    Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                  • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    • value: boolean

                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                  • get dependencies(): Stack[]

                                                                                                                                                                                                                    Return the stacks this stack depends on

                                                                                                                                                                                                                    Returns Stack[]

                                                                                                                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                                                                                                                  The pipeline source prefix

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                  Artifact bucket to use

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                  The ECR Repository to push to.

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  encryptionKey: Key

                                                                                                                                                                                                                  The encryption key use across

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                  diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index d55b243..e6eead1 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                    Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                    Properties to allow customizing the build.

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                        pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                        pipelineSourcePrefix?: string;
                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                        pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                        pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                        pipelineOutputPrefix?: string;
                                                                                                                                                                                                                        ecrRepository: IRepository;
                                                                                                                                                                                                                        ecrRepositoryImageTag: string;
                                                                                                                                                                                                                        projectType: ProjectType;
                                                                                                                                                                                                                        vpc: IVpc;
                                                                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                        encryptionKey: Key;
                                                                                                                                                                                                                        sourceCustomPath?: string;
                                                                                                                                                                                                                    }

                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                                      • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    description? +
                                                                                                                                                                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                        pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                        pipelineSourcePrefix?: string;
                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                        pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                        pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                        pipelineOutputPrefix?: string;
                                                                                                                                                                                                                        ecrRepository: IRepository;
                                                                                                                                                                                                                        ecrRepositoryImageTag: string;
                                                                                                                                                                                                                        projectType: ProjectType;
                                                                                                                                                                                                                        vpc: IVpc;
                                                                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                        encryptionKey: Key;
                                                                                                                                                                                                                        sourceCustomPath?: string;
                                                                                                                                                                                                                    }

                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                                      • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                    pipelineSourceBucket: IBucket

                                                                                                                                                                                                                    The pipeline source bucket

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    pipelineSourcePrefix?: string

                                                                                                                                                                                                                    The pipeline source prefix

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                    The pipeline artifact bucket to use

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    pipelineArtifactPrefix?: string

                                                                                                                                                                                                                    The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    pipelineOutputBucket: Bucket

                                                                                                                                                                                                                    The pipeline output bucket to use

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    pipelineOutputPrefix?: string

                                                                                                                                                                                                                    The pipeline output bucket prefix to use

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    ecrRepository: IRepository

                                                                                                                                                                                                                    ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    ecrRepositoryImageTag: string

                                                                                                                                                                                                                    Tag for the Build Host Image

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    projectType: ProjectType

                                                                                                                                                                                                                    The type of project being built.

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    vpc: IVpc

                                                                                                                                                                                                                    VPC where the networking setup resides.

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                    Additional policy statements to add to the build project.

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                    Additional build environment variables to the build project.

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    encryptionKey: Key

                                                                                                                                                                                                                    The encryption key use across

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    sourceCustomPath?: string

                                                                                                                                                                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    pipelineSourcePrefix?: string

                                                                                                                                                                                                                    The pipeline source prefix

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                    The pipeline artifact bucket to use

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    pipelineArtifactPrefix?: string

                                                                                                                                                                                                                    The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    pipelineOutputBucket: Bucket

                                                                                                                                                                                                                    The pipeline output bucket to use

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    pipelineOutputPrefix?: string

                                                                                                                                                                                                                    The pipeline output bucket prefix to use

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    ecrRepository: IRepository

                                                                                                                                                                                                                    ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    ecrRepositoryImageTag: string

                                                                                                                                                                                                                    Tag for the Build Host Image

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    projectType: ProjectType

                                                                                                                                                                                                                    The type of project being built.

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    vpc: IVpc

                                                                                                                                                                                                                    VPC where the networking setup resides.

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                    Additional policy statements to add to the build project.

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                    Additional build environment variables to the build project.

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    encryptionKey: Key

                                                                                                                                                                                                                    The encryption key use across

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    sourceCustomPath?: string

                                                                                                                                                                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                    +

                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                    diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index cf9533e..9e4786b 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                    aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                      Interface PipelineResourcesProps

                                                                                                                                                                                                                      Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      interface PipelineResourcesProps {
                                                                                                                                                                                                                          description?: string;
                                                                                                                                                                                                                          env?: Environment;
                                                                                                                                                                                                                          stackName?: string;
                                                                                                                                                                                                                          tags?: { [key: string]: string };
                                                                                                                                                                                                                          notificationArns?: string[];
                                                                                                                                                                                                                          synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                          terminationProtection?: boolean;
                                                                                                                                                                                                                          analyticsReporting?: boolean;
                                                                                                                                                                                                                          crossRegionReferences?: boolean;
                                                                                                                                                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                          suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                          propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                          resource_prefix: string;
                                                                                                                                                                                                                          ecrRepositoryName?: string;
                                                                                                                                                                                                                          pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                          pipelineSourceBucketName?: string;
                                                                                                                                                                                                                          pipelineOutputBucketName?: string;
                                                                                                                                                                                                                          loggingBucketName?: string;
                                                                                                                                                                                                                      }

                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                      • StackProps
                                                                                                                                                                                                                        • PipelineResourcesProps
                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                      description? +
                                                                                                                                                                                                                      interface PipelineResourcesProps {
                                                                                                                                                                                                                          description?: string;
                                                                                                                                                                                                                          env?: Environment;
                                                                                                                                                                                                                          stackName?: string;
                                                                                                                                                                                                                          tags?: { [key: string]: string };
                                                                                                                                                                                                                          notificationArns?: string[];
                                                                                                                                                                                                                          synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                          terminationProtection?: boolean;
                                                                                                                                                                                                                          analyticsReporting?: boolean;
                                                                                                                                                                                                                          crossRegionReferences?: boolean;
                                                                                                                                                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                          suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                          propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                          resource_prefix: string;
                                                                                                                                                                                                                          ecrRepositoryName?: string;
                                                                                                                                                                                                                          pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                          pipelineSourceBucketName?: string;
                                                                                                                                                                                                                          pipelineOutputBucketName?: string;
                                                                                                                                                                                                                          loggingBucketName?: string;
                                                                                                                                                                                                                      }

                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                      • StackProps
                                                                                                                                                                                                                        • PipelineResourcesProps
                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                      description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                      resource_prefix: string

                                                                                                                                                                                                                      The resource prefix

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      ecrRepositoryName?: string

                                                                                                                                                                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      pipelineArtifactBucketName?: string

                                                                                                                                                                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      pipelineSourceBucketName?: string

                                                                                                                                                                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      pipelineOutputBucketName?: string

                                                                                                                                                                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      loggingBucketName?: string

                                                                                                                                                                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      ecrRepositoryName?: string

                                                                                                                                                                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      pipelineArtifactBucketName?: string

                                                                                                                                                                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      pipelineSourceBucketName?: string

                                                                                                                                                                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      pipelineOutputBucketName?: string

                                                                                                                                                                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      loggingBucketName?: string

                                                                                                                                                                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                      From 660a0cd2941d1c9094f4c2479c1d191068fe08bb Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 15 Sep 2025 17:38:10 +0000 Subject: [PATCH 50/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@b22ec96c2efb850faad8477e3a?= =?UTF-8?q?f1b72e33de5435=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 96f67ec..3ac44a5 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                      aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                        Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                        The stack for creating a build pipeline.

                                                                                                                                                                                                                        See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                        • Stack
                                                                                                                                                                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                        constructor +

                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                        • Stack
                                                                                                                                                                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                        tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                                        templateOptions: ITemplateOptions

                                                                                                                                                                                                                        Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                        region: string

                                                                                                                                                                                                                        The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                        This value is resolved according to the following rules:

                                                                                                                                                                                                                        diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 1d6a32c..443a352 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                        aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                          Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                          The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                          For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                          • Stack
                                                                                                                                                                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                          constructor +

                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                          • Stack
                                                                                                                                                                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                          constructor

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          tags: TagManager

                                                                                                                                                                                                                          Tags to be applied to the stack.

                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          tags: TagManager

                                                                                                                                                                                                                          Tags to be applied to the stack.

                                                                                                                                                                                                                          templateOptions: ITemplateOptions

                                                                                                                                                                                                                          Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                          region: string

                                                                                                                                                                                                                          The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                          This value is resolved according to the following rules:

                                                                                                                                                                                                                          @@ -112,8 +112,8 @@

                                                                                                                                                                                                                          Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                          _crossRegionReferences: boolean

                                                                                                                                                                                                                          Whether cross region references are enabled for this stack

                                                                                                                                                                                                                          Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                          _notificationArns?: string[]

                                                                                                                                                                                                                          SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                                                          The ECR Repository where the image is located.

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                                                          The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          node: Node

                                                                                                                                                                                                                          The tree node.

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                                                          The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          node: Node

                                                                                                                                                                                                                          The tree node.

                                                                                                                                                                                                                          Accessors

                                                                                                                                                                                                                          • get terminationProtection(): boolean

                                                                                                                                                                                                                            Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                          • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                            • value: boolean

                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                          • get dependencies(): Stack[]

                                                                                                                                                                                                                            Return the stacks this stack depends on

                                                                                                                                                                                                                            Returns Stack[]

                                                                                                                                                                                                                          pipelineSourcePrefix?: string

                                                                                                                                                                                                                          The pipeline source prefix

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                          Artifact bucket to use

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                                                          The ECR Repository to push to.

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          encryptionKey: Key

                                                                                                                                                                                                                          The encryption key use across

                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                          diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index e6eead1..2648030 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                          aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                            Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                            Properties to allow customizing the build.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                ecrRepository: IRepository;
                                                                                                                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                projectType: ProjectType;
                                                                                                                                                                                                                                vpc: IVpc;
                                                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                encryptionKey: Key;
                                                                                                                                                                                                                                sourceCustomPath?: string;
                                                                                                                                                                                                                            }

                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                                              • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                            description? +
                                                                                                                                                                                                                            interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                ecrRepository: IRepository;
                                                                                                                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                projectType: ProjectType;
                                                                                                                                                                                                                                vpc: IVpc;
                                                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                encryptionKey: Key;
                                                                                                                                                                                                                                sourceCustomPath?: string;
                                                                                                                                                                                                                            }

                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                                              • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                            description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                            pipelineSourceBucket: IBucket

                                                                                                                                                                                                                            The pipeline source bucket

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            pipelineSourcePrefix?: string

                                                                                                                                                                                                                            The pipeline source prefix

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                            The pipeline artifact bucket to use

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            pipelineArtifactPrefix?: string

                                                                                                                                                                                                                            The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            pipelineOutputBucket: Bucket

                                                                                                                                                                                                                            The pipeline output bucket to use

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            pipelineOutputPrefix?: string

                                                                                                                                                                                                                            The pipeline output bucket prefix to use

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            ecrRepository: IRepository

                                                                                                                                                                                                                            ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                                                                                                                            Tag for the Build Host Image

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            projectType: ProjectType

                                                                                                                                                                                                                            The type of project being built.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            vpc: IVpc

                                                                                                                                                                                                                            VPC where the networking setup resides.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                            Additional build environment variables to the build project.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            encryptionKey: Key

                                                                                                                                                                                                                            The encryption key use across

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            sourceCustomPath?: string

                                                                                                                                                                                                                            Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            pipelineSourcePrefix?: string

                                                                                                                                                                                                                            The pipeline source prefix

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                            The pipeline artifact bucket to use

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            pipelineArtifactPrefix?: string

                                                                                                                                                                                                                            The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            pipelineOutputBucket: Bucket

                                                                                                                                                                                                                            The pipeline output bucket to use

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            pipelineOutputPrefix?: string

                                                                                                                                                                                                                            The pipeline output bucket prefix to use

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            ecrRepository: IRepository

                                                                                                                                                                                                                            ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                                                                                                                            Tag for the Build Host Image

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            projectType: ProjectType

                                                                                                                                                                                                                            The type of project being built.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            vpc: IVpc

                                                                                                                                                                                                                            VPC where the networking setup resides.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                            Additional build environment variables to the build project.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            encryptionKey: Key

                                                                                                                                                                                                                            The encryption key use across

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            sourceCustomPath?: string

                                                                                                                                                                                                                            Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                            diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 9e4786b..5413315 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                            aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                              Interface PipelineResourcesProps

                                                                                                                                                                                                                              Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              interface PipelineResourcesProps {
                                                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                                                  env?: Environment;
                                                                                                                                                                                                                                  stackName?: string;
                                                                                                                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                                                                                                                  notificationArns?: string[];
                                                                                                                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                  resource_prefix: string;
                                                                                                                                                                                                                                  ecrRepositoryName?: string;
                                                                                                                                                                                                                                  pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                  pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                  pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                  loggingBucketName?: string;
                                                                                                                                                                                                                              }

                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                              • StackProps
                                                                                                                                                                                                                                • PipelineResourcesProps
                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                              description? +
                                                                                                                                                                                                                              interface PipelineResourcesProps {
                                                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                                                  env?: Environment;
                                                                                                                                                                                                                                  stackName?: string;
                                                                                                                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                                                                                                                  notificationArns?: string[];
                                                                                                                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                  resource_prefix: string;
                                                                                                                                                                                                                                  ecrRepositoryName?: string;
                                                                                                                                                                                                                                  pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                  pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                  pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                  loggingBucketName?: string;
                                                                                                                                                                                                                              }

                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                              • StackProps
                                                                                                                                                                                                                                • PipelineResourcesProps
                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                              description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                              resource_prefix: string

                                                                                                                                                                                                                              The resource prefix

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              ecrRepositoryName?: string

                                                                                                                                                                                                                              The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              pipelineArtifactBucketName?: string

                                                                                                                                                                                                                              The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              pipelineSourceBucketName?: string

                                                                                                                                                                                                                              The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              pipelineOutputBucketName?: string

                                                                                                                                                                                                                              The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              loggingBucketName?: string

                                                                                                                                                                                                                              Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                              -

                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              ecrRepositoryName?: string

                                                                                                                                                                                                                              The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              pipelineArtifactBucketName?: string

                                                                                                                                                                                                                              The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              pipelineSourceBucketName?: string

                                                                                                                                                                                                                              The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              pipelineOutputBucketName?: string

                                                                                                                                                                                                                              The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              loggingBucketName?: string

                                                                                                                                                                                                                              Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                              From a3406f9d85c18a651383456f0cbc5f0fadd2097b Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 15 Sep 2025 20:02:05 +0000 Subject: [PATCH 51/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@d1ca606fa9be15e1ffe74cd77a?= =?UTF-8?q?068e1cf9583259=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 3ac44a5..4e1b567 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                The stack for creating a build pipeline.

                                                                                                                                                                                                                                See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                • Stack
                                                                                                                                                                                                                                  • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                constructor +

                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                • Stack
                                                                                                                                                                                                                                  • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                constructor

                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                                                templateOptions: ITemplateOptions

                                                                                                                                                                                                                                Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                region: string

                                                                                                                                                                                                                                The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                This value is resolved according to the following rules:

                                                                                                                                                                                                                                diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 443a352..2f67dd0 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                  Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                  The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                  For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                  • Stack
                                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                  constructor +

                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                  • Stack
                                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                  constructor

                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                  tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                  tags: TagManager

                                                                                                                                                                                                                                  Tags to be applied to the stack.

                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                  tags: TagManager

                                                                                                                                                                                                                                  Tags to be applied to the stack.

                                                                                                                                                                                                                                  templateOptions: ITemplateOptions

                                                                                                                                                                                                                                  Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                  region: string

                                                                                                                                                                                                                                  The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                  This value is resolved according to the following rules:

                                                                                                                                                                                                                                  @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                  Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                  _crossRegionReferences: boolean

                                                                                                                                                                                                                                  Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                  Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                  _notificationArns?: string[]

                                                                                                                                                                                                                                  SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                                  The ECR Repository where the image is located.

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                                  The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  node: Node

                                                                                                                                                                                                                                  The tree node.

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                                  The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  node: Node

                                                                                                                                                                                                                                  The tree node.

                                                                                                                                                                                                                                  Accessors

                                                                                                                                                                                                                                  • get terminationProtection(): boolean

                                                                                                                                                                                                                                    Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                  • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • value: boolean

                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                  • get dependencies(): Stack[]

                                                                                                                                                                                                                                    Return the stacks this stack depends on

                                                                                                                                                                                                                                    Returns Stack[]

                                                                                                                                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                                                                                                                                  The pipeline source prefix

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                  Artifact bucket to use

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                                  The ECR Repository to push to.

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  encryptionKey: Key

                                                                                                                                                                                                                                  The encryption key use across

                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                  diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 2648030..e6e2d8f 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                    Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                    Properties to allow customizing the build.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                        pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                        pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                        pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                        pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                        pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                        ecrRepository: IRepository;
                                                                                                                                                                                                                                        ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                        projectType: ProjectType;
                                                                                                                                                                                                                                        vpc: IVpc;
                                                                                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                        encryptionKey: Key;
                                                                                                                                                                                                                                        sourceCustomPath?: string;
                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                                                      • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                    description? +
                                                                                                                                                                                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                        pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                        pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                        pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                        pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                        pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                        ecrRepository: IRepository;
                                                                                                                                                                                                                                        ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                        projectType: ProjectType;
                                                                                                                                                                                                                                        vpc: IVpc;
                                                                                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                        encryptionKey: Key;
                                                                                                                                                                                                                                        sourceCustomPath?: string;
                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                                                      • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                    description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                    pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                    The pipeline source bucket

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    pipelineSourcePrefix?: string

                                                                                                                                                                                                                                    The pipeline source prefix

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                    The pipeline artifact bucket to use

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                    The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                    The pipeline output bucket to use

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    pipelineOutputPrefix?: string

                                                                                                                                                                                                                                    The pipeline output bucket prefix to use

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    ecrRepository: IRepository

                                                                                                                                                                                                                                    ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    ecrRepositoryImageTag: string

                                                                                                                                                                                                                                    Tag for the Build Host Image

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    projectType: ProjectType

                                                                                                                                                                                                                                    The type of project being built.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    vpc: IVpc

                                                                                                                                                                                                                                    VPC where the networking setup resides.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                    Additional policy statements to add to the build project.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                    Additional build environment variables to the build project.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    encryptionKey: Key

                                                                                                                                                                                                                                    The encryption key use across

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    sourceCustomPath?: string

                                                                                                                                                                                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    pipelineSourcePrefix?: string

                                                                                                                                                                                                                                    The pipeline source prefix

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                    The pipeline artifact bucket to use

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                    The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                    The pipeline output bucket to use

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    pipelineOutputPrefix?: string

                                                                                                                                                                                                                                    The pipeline output bucket prefix to use

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    ecrRepository: IRepository

                                                                                                                                                                                                                                    ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    ecrRepositoryImageTag: string

                                                                                                                                                                                                                                    Tag for the Build Host Image

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    projectType: ProjectType

                                                                                                                                                                                                                                    The type of project being built.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    vpc: IVpc

                                                                                                                                                                                                                                    VPC where the networking setup resides.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                    Additional policy statements to add to the build project.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                    Additional build environment variables to the build project.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    encryptionKey: Key

                                                                                                                                                                                                                                    The encryption key use across

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    sourceCustomPath?: string

                                                                                                                                                                                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                    diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 5413315..592c505 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                    aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                      Interface PipelineResourcesProps

                                                                                                                                                                                                                                      Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      interface PipelineResourcesProps {
                                                                                                                                                                                                                                          description?: string;
                                                                                                                                                                                                                                          env?: Environment;
                                                                                                                                                                                                                                          stackName?: string;
                                                                                                                                                                                                                                          tags?: { [key: string]: string };
                                                                                                                                                                                                                                          notificationArns?: string[];
                                                                                                                                                                                                                                          synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                          terminationProtection?: boolean;
                                                                                                                                                                                                                                          analyticsReporting?: boolean;
                                                                                                                                                                                                                                          crossRegionReferences?: boolean;
                                                                                                                                                                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                          suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                          propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                          resource_prefix: string;
                                                                                                                                                                                                                                          ecrRepositoryName?: string;
                                                                                                                                                                                                                                          pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                          pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                          pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                          loggingBucketName?: string;
                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                      • StackProps
                                                                                                                                                                                                                                        • PipelineResourcesProps
                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      description? +
                                                                                                                                                                                                                                      interface PipelineResourcesProps {
                                                                                                                                                                                                                                          description?: string;
                                                                                                                                                                                                                                          env?: Environment;
                                                                                                                                                                                                                                          stackName?: string;
                                                                                                                                                                                                                                          tags?: { [key: string]: string };
                                                                                                                                                                                                                                          notificationArns?: string[];
                                                                                                                                                                                                                                          synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                          terminationProtection?: boolean;
                                                                                                                                                                                                                                          analyticsReporting?: boolean;
                                                                                                                                                                                                                                          crossRegionReferences?: boolean;
                                                                                                                                                                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                          suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                          propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                          resource_prefix: string;
                                                                                                                                                                                                                                          ecrRepositoryName?: string;
                                                                                                                                                                                                                                          pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                          pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                          pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                          loggingBucketName?: string;
                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                      • StackProps
                                                                                                                                                                                                                                        • PipelineResourcesProps
                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                      resource_prefix: string

                                                                                                                                                                                                                                      The resource prefix

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      ecrRepositoryName?: string

                                                                                                                                                                                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      pipelineSourceBucketName?: string

                                                                                                                                                                                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      pipelineOutputBucketName?: string

                                                                                                                                                                                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      loggingBucketName?: string

                                                                                                                                                                                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      ecrRepositoryName?: string

                                                                                                                                                                                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      pipelineSourceBucketName?: string

                                                                                                                                                                                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      pipelineOutputBucketName?: string

                                                                                                                                                                                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      loggingBucketName?: string

                                                                                                                                                                                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                      From edace43a744703652419ac8941bf3a64e45a710a Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 15 Sep 2025 20:03:00 +0000 Subject: [PATCH 52/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@e3228eaa0a2d75e92569dccadc?= =?UTF-8?q?eb5a39616c3c14=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 4e1b567..d4ff0dc 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                      aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                        Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                        The stack for creating a build pipeline.

                                                                                                                                                                                                                                        See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                        • Stack
                                                                                                                                                                                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                        constructor +

                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                        • Stack
                                                                                                                                                                                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                        tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                                                        templateOptions: ITemplateOptions

                                                                                                                                                                                                                                        Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                        region: string

                                                                                                                                                                                                                                        The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                        This value is resolved according to the following rules:

                                                                                                                                                                                                                                        diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 2f67dd0..b21fb6c 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                        aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                          Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                          The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                          For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                          • Stack
                                                                                                                                                                                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                          constructor +

                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                          • Stack
                                                                                                                                                                                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                          constructor

                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                          tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                          tags: TagManager

                                                                                                                                                                                                                                          Tags to be applied to the stack.

                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                          tags: TagManager

                                                                                                                                                                                                                                          Tags to be applied to the stack.

                                                                                                                                                                                                                                          templateOptions: ITemplateOptions

                                                                                                                                                                                                                                          Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                          region: string

                                                                                                                                                                                                                                          The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                          This value is resolved according to the following rules:

                                                                                                                                                                                                                                          @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                          Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                          _crossRegionReferences: boolean

                                                                                                                                                                                                                                          Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                          Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                          _notificationArns?: string[]

                                                                                                                                                                                                                                          SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                                                                          The ECR Repository where the image is located.

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                                                                          The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          node: Node

                                                                                                                                                                                                                                          The tree node.

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                                                                          The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          node: Node

                                                                                                                                                                                                                                          The tree node.

                                                                                                                                                                                                                                          Accessors

                                                                                                                                                                                                                                          • get terminationProtection(): boolean

                                                                                                                                                                                                                                            Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                          • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                            • value: boolean

                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                          • get dependencies(): Stack[]

                                                                                                                                                                                                                                            Return the stacks this stack depends on

                                                                                                                                                                                                                                            Returns Stack[]

                                                                                                                                                                                                                                          pipelineSourcePrefix?: string

                                                                                                                                                                                                                                          The pipeline source prefix

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                          Artifact bucket to use

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                                                                          The ECR Repository to push to.

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          encryptionKey: Key

                                                                                                                                                                                                                                          The encryption key use across

                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                          diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index e6e2d8f..19fb7f2 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                          aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                            Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                            Properties to allow customizing the build.

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                ecrRepository: IRepository;
                                                                                                                                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                projectType: ProjectType;
                                                                                                                                                                                                                                                vpc: IVpc;
                                                                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                encryptionKey: Key;
                                                                                                                                                                                                                                                sourceCustomPath?: string;
                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                                                              • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                            description? +
                                                                                                                                                                                                                                            interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                ecrRepository: IRepository;
                                                                                                                                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                projectType: ProjectType;
                                                                                                                                                                                                                                                vpc: IVpc;
                                                                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                encryptionKey: Key;
                                                                                                                                                                                                                                                sourceCustomPath?: string;
                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                                                              • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                            description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                            pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                            The pipeline source bucket

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            pipelineSourcePrefix?: string

                                                                                                                                                                                                                                            The pipeline source prefix

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                            The pipeline artifact bucket to use

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                            The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                            The pipeline output bucket to use

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            pipelineOutputPrefix?: string

                                                                                                                                                                                                                                            The pipeline output bucket prefix to use

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            ecrRepository: IRepository

                                                                                                                                                                                                                                            ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                                                                                                                                            Tag for the Build Host Image

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            projectType: ProjectType

                                                                                                                                                                                                                                            The type of project being built.

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            vpc: IVpc

                                                                                                                                                                                                                                            VPC where the networking setup resides.

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                            Additional build environment variables to the build project.

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            encryptionKey: Key

                                                                                                                                                                                                                                            The encryption key use across

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            sourceCustomPath?: string

                                                                                                                                                                                                                                            Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            pipelineSourcePrefix?: string

                                                                                                                                                                                                                                            The pipeline source prefix

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                            The pipeline artifact bucket to use

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                            The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                            The pipeline output bucket to use

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            pipelineOutputPrefix?: string

                                                                                                                                                                                                                                            The pipeline output bucket prefix to use

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            ecrRepository: IRepository

                                                                                                                                                                                                                                            ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                                                                                                                                            Tag for the Build Host Image

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            projectType: ProjectType

                                                                                                                                                                                                                                            The type of project being built.

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            vpc: IVpc

                                                                                                                                                                                                                                            VPC where the networking setup resides.

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                            Additional build environment variables to the build project.

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            encryptionKey: Key

                                                                                                                                                                                                                                            The encryption key use across

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            sourceCustomPath?: string

                                                                                                                                                                                                                                            Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                            diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 592c505..f495970 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                            aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                              Interface PipelineResourcesProps

                                                                                                                                                                                                                                              Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              interface PipelineResourcesProps {
                                                                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                                                                  env?: Environment;
                                                                                                                                                                                                                                                  stackName?: string;
                                                                                                                                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                                                                                                                                  notificationArns?: string[];
                                                                                                                                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                  resource_prefix: string;
                                                                                                                                                                                                                                                  ecrRepositoryName?: string;
                                                                                                                                                                                                                                                  pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                  pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                  pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                  loggingBucketName?: string;
                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                              • StackProps
                                                                                                                                                                                                                                                • PipelineResourcesProps
                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                              description? +
                                                                                                                                                                                                                                              interface PipelineResourcesProps {
                                                                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                                                                  env?: Environment;
                                                                                                                                                                                                                                                  stackName?: string;
                                                                                                                                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                                                                                                                                  notificationArns?: string[];
                                                                                                                                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                  resource_prefix: string;
                                                                                                                                                                                                                                                  ecrRepositoryName?: string;
                                                                                                                                                                                                                                                  pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                  pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                  pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                  loggingBucketName?: string;
                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                              • StackProps
                                                                                                                                                                                                                                                • PipelineResourcesProps
                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                              description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                              resource_prefix: string

                                                                                                                                                                                                                                              The resource prefix

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              ecrRepositoryName?: string

                                                                                                                                                                                                                                              The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                              The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              pipelineSourceBucketName?: string

                                                                                                                                                                                                                                              The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              pipelineOutputBucketName?: string

                                                                                                                                                                                                                                              The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              loggingBucketName?: string

                                                                                                                                                                                                                                              Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              ecrRepositoryName?: string

                                                                                                                                                                                                                                              The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                              The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              pipelineSourceBucketName?: string

                                                                                                                                                                                                                                              The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              pipelineOutputBucketName?: string

                                                                                                                                                                                                                                              The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              loggingBucketName?: string

                                                                                                                                                                                                                                              Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                              From ddb758cb1be077a5ad0aabb0eb6319c983f58671 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 15 Sep 2025 20:04:53 +0000 Subject: [PATCH 53/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@1997f761bb53a78659462d2847?= =?UTF-8?q?466555c9a80063=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index d4ff0dc..a6a50da 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                The stack for creating a build pipeline.

                                                                                                                                                                                                                                                See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                • Stack
                                                                                                                                                                                                                                                  • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                constructor +

                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                • Stack
                                                                                                                                                                                                                                                  • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                constructor

                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                                                                templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                region: string

                                                                                                                                                                                                                                                The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                This value is resolved according to the following rules:

                                                                                                                                                                                                                                                diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index b21fb6c..fce080a 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                  Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                  The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                  For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                  • Stack
                                                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                  constructor +

                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                  • Stack
                                                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                  constructor

                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                  tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                  tags: TagManager

                                                                                                                                                                                                                                                  Tags to be applied to the stack.

                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                  tags: TagManager

                                                                                                                                                                                                                                                  Tags to be applied to the stack.

                                                                                                                                                                                                                                                  templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                  Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                  region: string

                                                                                                                                                                                                                                                  The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                  This value is resolved according to the following rules:

                                                                                                                                                                                                                                                  @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                  Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                  _crossRegionReferences: boolean

                                                                                                                                                                                                                                                  Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                  Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                  _notificationArns?: string[]

                                                                                                                                                                                                                                                  SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                                                  The ECR Repository where the image is located.

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                  The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  node: Node

                                                                                                                                                                                                                                                  The tree node.

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                  The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  node: Node

                                                                                                                                                                                                                                                  The tree node.

                                                                                                                                                                                                                                                  Accessors

                                                                                                                                                                                                                                                  • get terminationProtection(): boolean

                                                                                                                                                                                                                                                    Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                  • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                    • value: boolean

                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                  • get dependencies(): Stack[]

                                                                                                                                                                                                                                                    Return the stacks this stack depends on

                                                                                                                                                                                                                                                    Returns Stack[]

                                                                                                                                                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                  The pipeline source prefix

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                  Artifact bucket to use

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                                                  The ECR Repository to push to.

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  encryptionKey: Key

                                                                                                                                                                                                                                                  The encryption key use across

                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                  diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 19fb7f2..0683f72 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                    Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                    Properties to allow customizing the build.

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                        pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                        pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                        pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                        pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                        pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                        ecrRepository: IRepository;
                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                        projectType: ProjectType;
                                                                                                                                                                                                                                                        vpc: IVpc;
                                                                                                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                        encryptionKey: Key;
                                                                                                                                                                                                                                                        sourceCustomPath?: string;
                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                                                                      • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                    description? +
                                                                                                                                                                                                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                        pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                        pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                        pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                        pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                        pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                        ecrRepository: IRepository;
                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                        projectType: ProjectType;
                                                                                                                                                                                                                                                        vpc: IVpc;
                                                                                                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                        encryptionKey: Key;
                                                                                                                                                                                                                                                        sourceCustomPath?: string;
                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                                                                      • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                    description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                    pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                    The pipeline source bucket

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                    The pipeline source prefix

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                    The pipeline artifact bucket to use

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                    The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                    The pipeline output bucket to use

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                    The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    ecrRepository: IRepository

                                                                                                                                                                                                                                                    ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                    Tag for the Build Host Image

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    projectType: ProjectType

                                                                                                                                                                                                                                                    The type of project being built.

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    vpc: IVpc

                                                                                                                                                                                                                                                    VPC where the networking setup resides.

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                    Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                    Additional build environment variables to the build project.

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    encryptionKey: Key

                                                                                                                                                                                                                                                    The encryption key use across

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    sourceCustomPath?: string

                                                                                                                                                                                                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                    The pipeline source prefix

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                    The pipeline artifact bucket to use

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                    The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                    The pipeline output bucket to use

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                    The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    ecrRepository: IRepository

                                                                                                                                                                                                                                                    ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                    Tag for the Build Host Image

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    projectType: ProjectType

                                                                                                                                                                                                                                                    The type of project being built.

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    vpc: IVpc

                                                                                                                                                                                                                                                    VPC where the networking setup resides.

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                    Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                    Additional build environment variables to the build project.

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    encryptionKey: Key

                                                                                                                                                                                                                                                    The encryption key use across

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    sourceCustomPath?: string

                                                                                                                                                                                                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                    diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index f495970..a3e0bf1 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                    aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                      Interface PipelineResourcesProps

                                                                                                                                                                                                                                                      Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      interface PipelineResourcesProps {
                                                                                                                                                                                                                                                          description?: string;
                                                                                                                                                                                                                                                          env?: Environment;
                                                                                                                                                                                                                                                          stackName?: string;
                                                                                                                                                                                                                                                          tags?: { [key: string]: string };
                                                                                                                                                                                                                                                          notificationArns?: string[];
                                                                                                                                                                                                                                                          synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                          terminationProtection?: boolean;
                                                                                                                                                                                                                                                          analyticsReporting?: boolean;
                                                                                                                                                                                                                                                          crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                          suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                          propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                          resource_prefix: string;
                                                                                                                                                                                                                                                          ecrRepositoryName?: string;
                                                                                                                                                                                                                                                          pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                          pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                          pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                          loggingBucketName?: string;
                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                      • StackProps
                                                                                                                                                                                                                                                        • PipelineResourcesProps
                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                      description? +
                                                                                                                                                                                                                                                      interface PipelineResourcesProps {
                                                                                                                                                                                                                                                          description?: string;
                                                                                                                                                                                                                                                          env?: Environment;
                                                                                                                                                                                                                                                          stackName?: string;
                                                                                                                                                                                                                                                          tags?: { [key: string]: string };
                                                                                                                                                                                                                                                          notificationArns?: string[];
                                                                                                                                                                                                                                                          synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                          terminationProtection?: boolean;
                                                                                                                                                                                                                                                          analyticsReporting?: boolean;
                                                                                                                                                                                                                                                          crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                          suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                          propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                          resource_prefix: string;
                                                                                                                                                                                                                                                          ecrRepositoryName?: string;
                                                                                                                                                                                                                                                          pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                          pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                          pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                          loggingBucketName?: string;
                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                      • StackProps
                                                                                                                                                                                                                                                        • PipelineResourcesProps
                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                      description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                      resource_prefix: string

                                                                                                                                                                                                                                                      The resource prefix

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      ecrRepositoryName?: string

                                                                                                                                                                                                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      loggingBucketName?: string

                                                                                                                                                                                                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      ecrRepositoryName?: string

                                                                                                                                                                                                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      loggingBucketName?: string

                                                                                                                                                                                                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                      From 58aeb871382ef909f32d5203f545b2da2f4d34ce Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 15 Sep 2025 20:05:43 +0000 Subject: [PATCH 54/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@31d148491b3d2a60375fae7e3a?= =?UTF-8?q?541a157828ed8f=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index a6a50da..53714f5 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                      aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                        Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                        The stack for creating a build pipeline.

                                                                                                                                                                                                                                                        See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                        • Stack
                                                                                                                                                                                                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                        constructor +

                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                        • Stack
                                                                                                                                                                                                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                        tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                                                                        templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                        Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                        region: string

                                                                                                                                                                                                                                                        The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                        This value is resolved according to the following rules:

                                                                                                                                                                                                                                                        diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index fce080a..f0bb1cc 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                        aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                          Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                          The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                          For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          • Stack
                                                                                                                                                                                                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                          constructor +

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          • Stack
                                                                                                                                                                                                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                          constructor

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          tags: TagManager

                                                                                                                                                                                                                                                          Tags to be applied to the stack.

                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          tags: TagManager

                                                                                                                                                                                                                                                          Tags to be applied to the stack.

                                                                                                                                                                                                                                                          templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                          Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                          region: string

                                                                                                                                                                                                                                                          The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                          This value is resolved according to the following rules:

                                                                                                                                                                                                                                                          @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                          Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                          _crossRegionReferences: boolean

                                                                                                                                                                                                                                                          Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                          Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                          _notificationArns?: string[]

                                                                                                                                                                                                                                                          SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                                                                                          The ECR Repository where the image is located.

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                          The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          node: Node

                                                                                                                                                                                                                                                          The tree node.

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                          The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          node: Node

                                                                                                                                                                                                                                                          The tree node.

                                                                                                                                                                                                                                                          Accessors

                                                                                                                                                                                                                                                          • get terminationProtection(): boolean

                                                                                                                                                                                                                                                            Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                          • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                            • value: boolean

                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                          • get dependencies(): Stack[]

                                                                                                                                                                                                                                                            Return the stacks this stack depends on

                                                                                                                                                                                                                                                            Returns Stack[]

                                                                                                                                                                                                                                                          pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                          The pipeline source prefix

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                          Artifact bucket to use

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                                                                                          The ECR Repository to push to.

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          encryptionKey: Key

                                                                                                                                                                                                                                                          The encryption key use across

                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                          diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 0683f72..c412933 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                          aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                            Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                            Properties to allow customizing the build.

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                ecrRepository: IRepository;
                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                projectType: ProjectType;
                                                                                                                                                                                                                                                                vpc: IVpc;
                                                                                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                encryptionKey: Key;
                                                                                                                                                                                                                                                                sourceCustomPath?: string;
                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                                                                              • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                            description? +
                                                                                                                                                                                                                                                            interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                ecrRepository: IRepository;
                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                projectType: ProjectType;
                                                                                                                                                                                                                                                                vpc: IVpc;
                                                                                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                encryptionKey: Key;
                                                                                                                                                                                                                                                                sourceCustomPath?: string;
                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                                                                              • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                            description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                            pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                            The pipeline source bucket

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                            The pipeline source prefix

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                            The pipeline artifact bucket to use

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                            The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                            The pipeline output bucket to use

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                            The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            ecrRepository: IRepository

                                                                                                                                                                                                                                                            ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                            Tag for the Build Host Image

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            projectType: ProjectType

                                                                                                                                                                                                                                                            The type of project being built.

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            vpc: IVpc

                                                                                                                                                                                                                                                            VPC where the networking setup resides.

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                            Additional build environment variables to the build project.

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            encryptionKey: Key

                                                                                                                                                                                                                                                            The encryption key use across

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            sourceCustomPath?: string

                                                                                                                                                                                                                                                            Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                            The pipeline source prefix

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                            The pipeline artifact bucket to use

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                            The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                            The pipeline output bucket to use

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                            The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            ecrRepository: IRepository

                                                                                                                                                                                                                                                            ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                            Tag for the Build Host Image

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            projectType: ProjectType

                                                                                                                                                                                                                                                            The type of project being built.

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            vpc: IVpc

                                                                                                                                                                                                                                                            VPC where the networking setup resides.

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                            Additional build environment variables to the build project.

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            encryptionKey: Key

                                                                                                                                                                                                                                                            The encryption key use across

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            sourceCustomPath?: string

                                                                                                                                                                                                                                                            Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                            diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index a3e0bf1..4725bdb 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                            aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                              Interface PipelineResourcesProps

                                                                                                                                                                                                                                                              Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                                                                                  env?: Environment;
                                                                                                                                                                                                                                                                  stackName?: string;
                                                                                                                                                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                  notificationArns?: string[];
                                                                                                                                                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                  resource_prefix: string;
                                                                                                                                                                                                                                                                  ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                  pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                  pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                  pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                  loggingBucketName?: string;
                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                              • StackProps
                                                                                                                                                                                                                                                                • PipelineResourcesProps
                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                              description? +
                                                                                                                                                                                                                                                              interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                                                                                  env?: Environment;
                                                                                                                                                                                                                                                                  stackName?: string;
                                                                                                                                                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                  notificationArns?: string[];
                                                                                                                                                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                  resource_prefix: string;
                                                                                                                                                                                                                                                                  ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                  pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                  pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                  pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                  loggingBucketName?: string;
                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                              • StackProps
                                                                                                                                                                                                                                                                • PipelineResourcesProps
                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                              description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                              resource_prefix: string

                                                                                                                                                                                                                                                              The resource prefix

                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              ecrRepositoryName?: string

                                                                                                                                                                                                                                                              The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                              The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                              The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                              The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              loggingBucketName?: string

                                                                                                                                                                                                                                                              Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              ecrRepositoryName?: string

                                                                                                                                                                                                                                                              The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                              The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                              The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                              The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              loggingBucketName?: string

                                                                                                                                                                                                                                                              Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                              From 89988dc73afbdb53f438352d1d3e0a05c2bde178 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 15 Sep 2025 20:09:03 +0000 Subject: [PATCH 55/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@199fdac3a2447badf807e5e692?= =?UTF-8?q?4275ead89ad50d=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 53714f5..9c126b6 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                                The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                • Stack
                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                constructor +

                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                • Stack
                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                constructor

                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                                                                                templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                region: string

                                                                                                                                                                                                                                                                The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index f0bb1cc..256b99f 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                  Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                                  The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                                  For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                  • Stack
                                                                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                                  constructor +

                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                  • Stack
                                                                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                                  constructor

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  tags: TagManager

                                                                                                                                                                                                                                                                  Tags to be applied to the stack.

                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  tags: TagManager

                                                                                                                                                                                                                                                                  Tags to be applied to the stack.

                                                                                                                                                                                                                                                                  templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                  Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                  region: string

                                                                                                                                                                                                                                                                  The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                  This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                  @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                                  Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                  _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                  Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                  Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                  _notificationArns?: string[]

                                                                                                                                                                                                                                                                  SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                                                                  The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                  The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  node: Node

                                                                                                                                                                                                                                                                  The tree node.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                  The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  node: Node

                                                                                                                                                                                                                                                                  The tree node.

                                                                                                                                                                                                                                                                  Accessors

                                                                                                                                                                                                                                                                  • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                    Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                  • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • value: boolean

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                    Return the stacks this stack depends on

                                                                                                                                                                                                                                                                    Returns Stack[]

                                                                                                                                                                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                  The pipeline source prefix

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                  Artifact bucket to use

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                                                                  The ECR Repository to push to.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  encryptionKey: Key

                                                                                                                                                                                                                                                                  The encryption key use across

                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                  diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index c412933..5135cc1 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                    Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                                    Properties to allow customizing the build.

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                        pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                        pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                        pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                        pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                        pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                        ecrRepository: IRepository;
                                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                        projectType: ProjectType;
                                                                                                                                                                                                                                                                        vpc: IVpc;
                                                                                                                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                        encryptionKey: Key;
                                                                                                                                                                                                                                                                        sourceCustomPath?: string;
                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                                                                                      • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                    description? +
                                                                                                                                                                                                                                                                    interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                        pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                        pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                        pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                        pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                        pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                        ecrRepository: IRepository;
                                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                        projectType: ProjectType;
                                                                                                                                                                                                                                                                        vpc: IVpc;
                                                                                                                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                        encryptionKey: Key;
                                                                                                                                                                                                                                                                        sourceCustomPath?: string;
                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                                                                                      • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                    description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                                    pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                    The pipeline source bucket

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                    The pipeline source prefix

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                    The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                    The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                    The pipeline output bucket to use

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                    The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    ecrRepository: IRepository

                                                                                                                                                                                                                                                                    ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                    Tag for the Build Host Image

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    projectType: ProjectType

                                                                                                                                                                                                                                                                    The type of project being built.

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    vpc: IVpc

                                                                                                                                                                                                                                                                    VPC where the networking setup resides.

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                    Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                    Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    encryptionKey: Key

                                                                                                                                                                                                                                                                    The encryption key use across

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    sourceCustomPath?: string

                                                                                                                                                                                                                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                    The pipeline source prefix

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                    The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                    The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                    The pipeline output bucket to use

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                    The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    ecrRepository: IRepository

                                                                                                                                                                                                                                                                    ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                    Tag for the Build Host Image

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    projectType: ProjectType

                                                                                                                                                                                                                                                                    The type of project being built.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    vpc: IVpc

                                                                                                                                                                                                                                                                    VPC where the networking setup resides.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                    Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                    Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    encryptionKey: Key

                                                                                                                                                                                                                                                                    The encryption key use across

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    sourceCustomPath?: string

                                                                                                                                                                                                                                                                    Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                    diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 4725bdb..ff4f1d3 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                    aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                      Interface PipelineResourcesProps

                                                                                                                                                                                                                                                                      Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                          description?: string;
                                                                                                                                                                                                                                                                          env?: Environment;
                                                                                                                                                                                                                                                                          stackName?: string;
                                                                                                                                                                                                                                                                          tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                          notificationArns?: string[];
                                                                                                                                                                                                                                                                          synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                          terminationProtection?: boolean;
                                                                                                                                                                                                                                                                          analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                          crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                          suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                          propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                          resource_prefix: string;
                                                                                                                                                                                                                                                                          ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                          pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                          pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                          pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                          loggingBucketName?: string;
                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                      • StackProps
                                                                                                                                                                                                                                                                        • PipelineResourcesProps
                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                      description? +
                                                                                                                                                                                                                                                                      interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                          description?: string;
                                                                                                                                                                                                                                                                          env?: Environment;
                                                                                                                                                                                                                                                                          stackName?: string;
                                                                                                                                                                                                                                                                          tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                          notificationArns?: string[];
                                                                                                                                                                                                                                                                          synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                          terminationProtection?: boolean;
                                                                                                                                                                                                                                                                          analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                          crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                          permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                          suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                          propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                          resource_prefix: string;
                                                                                                                                                                                                                                                                          ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                          pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                          pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                          pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                          loggingBucketName?: string;
                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                      • StackProps
                                                                                                                                                                                                                                                                        • PipelineResourcesProps
                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                      description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                                      resource_prefix: string

                                                                                                                                                                                                                                                                      The resource prefix

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      ecrRepositoryName?: string

                                                                                                                                                                                                                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      loggingBucketName?: string

                                                                                                                                                                                                                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      ecrRepositoryName?: string

                                                                                                                                                                                                                                                                      The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                      The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                      The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                      The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      loggingBucketName?: string

                                                                                                                                                                                                                                                                      Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                      From 91a8aa1f9eabc26dea8d39a1fd220d65f659de5a Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 22 Sep 2025 17:52:06 +0000 Subject: [PATCH 56/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@ab4220ac8bd35b255f8c11e418?= =?UTF-8?q?7ad952fae228aa=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 9c126b6..78e6a57 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                      aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                        Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                                        The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                        See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                        • Stack
                                                                                                                                                                                                                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                        constructor +

                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                        • Stack
                                                                                                                                                                                                                                                                          • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                        tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                                                                                        templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                        Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                        region: string

                                                                                                                                                                                                                                                                        The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                        This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                        diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 256b99f..819c7f5 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                        aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                          Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                                          The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                                          For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                          • Stack
                                                                                                                                                                                                                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                          constructor +

                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                          • Stack
                                                                                                                                                                                                                                                                            • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                          constructor

                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                          tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                          tags: TagManager

                                                                                                                                                                                                                                                                          Tags to be applied to the stack.

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                          tags: TagManager

                                                                                                                                                                                                                                                                          Tags to be applied to the stack.

                                                                                                                                                                                                                                                                          templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                          Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                          region: string

                                                                                                                                                                                                                                                                          The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                          This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                          @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                                          Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                          _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                          Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                          Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                          _notificationArns?: string[]

                                                                                                                                                                                                                                                                          SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                                                                                                          The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                          The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          node: Node

                                                                                                                                                                                                                                                                          The tree node.

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                          The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          node: Node

                                                                                                                                                                                                                                                                          The tree node.

                                                                                                                                                                                                                                                                          Accessors

                                                                                                                                                                                                                                                                          • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                            Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                                          • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                            • value: boolean

                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                          • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                            Return the stacks this stack depends on

                                                                                                                                                                                                                                                                            Returns Stack[]

                                                                                                                                                                                                                                                                          pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                          The pipeline source prefix

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                          Artifact bucket to use

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                                                                                                          The ECR Repository to push to.

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          encryptionKey: Key

                                                                                                                                                                                                                                                                          The encryption key use across

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                          diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 5135cc1..52a7352 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                          aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                            Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                                            Properties to allow customizing the build.

                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                projectType: ProjectType;
                                                                                                                                                                                                                                                                                vpc: IVpc;
                                                                                                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                encryptionKey: Key;
                                                                                                                                                                                                                                                                                sourceCustomPath?: string;
                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                                                                                              • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                            description? +
                                                                                                                                                                                                                                                                            interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                projectType: ProjectType;
                                                                                                                                                                                                                                                                                vpc: IVpc;
                                                                                                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                encryptionKey: Key;
                                                                                                                                                                                                                                                                                sourceCustomPath?: string;
                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                                                                                              • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                            description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                                            pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                            The pipeline source bucket

                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                            The pipeline source prefix

                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                            The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                            The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                            The pipeline output bucket to use

                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                            The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            ecrRepository: IRepository

                                                                                                                                                                                                                                                                            ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                            Tag for the Build Host Image

                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            projectType: ProjectType

                                                                                                                                                                                                                                                                            The type of project being built.

                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            vpc: IVpc

                                                                                                                                                                                                                                                                            VPC where the networking setup resides.

                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                            Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            encryptionKey: Key

                                                                                                                                                                                                                                                                            The encryption key use across

                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            sourceCustomPath?: string

                                                                                                                                                                                                                                                                            Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                            The pipeline source prefix

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                            The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                            The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                            The pipeline output bucket to use

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                            The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            ecrRepository: IRepository

                                                                                                                                                                                                                                                                            ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                            Tag for the Build Host Image

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            projectType: ProjectType

                                                                                                                                                                                                                                                                            The type of project being built.

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            vpc: IVpc

                                                                                                                                                                                                                                                                            VPC where the networking setup resides.

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                            Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            encryptionKey: Key

                                                                                                                                                                                                                                                                            The encryption key use across

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            sourceCustomPath?: string

                                                                                                                                                                                                                                                                            Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                            diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index ff4f1d3..17e627e 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                            aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                              Interface PipelineResourcesProps

                                                                                                                                                                                                                                                                              Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                                                                                                  env?: Environment;
                                                                                                                                                                                                                                                                                  stackName?: string;
                                                                                                                                                                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                  notificationArns?: string[];
                                                                                                                                                                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                  resource_prefix: string;
                                                                                                                                                                                                                                                                                  ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                  pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                  pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                  pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                  loggingBucketName?: string;
                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                              • StackProps
                                                                                                                                                                                                                                                                                • PipelineResourcesProps
                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              description? +
                                                                                                                                                                                                                                                                              interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                                                                                                  env?: Environment;
                                                                                                                                                                                                                                                                                  stackName?: string;
                                                                                                                                                                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                  notificationArns?: string[];
                                                                                                                                                                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                  resource_prefix: string;
                                                                                                                                                                                                                                                                                  ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                  pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                  pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                  pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                  loggingBucketName?: string;
                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                              • StackProps
                                                                                                                                                                                                                                                                                • PipelineResourcesProps
                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                                              resource_prefix: string

                                                                                                                                                                                                                                                                              The resource prefix

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              ecrRepositoryName?: string

                                                                                                                                                                                                                                                                              The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                              The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                              The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                              The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              loggingBucketName?: string

                                                                                                                                                                                                                                                                              Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              ecrRepositoryName?: string

                                                                                                                                                                                                                                                                              The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                              The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                              The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                              The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              loggingBucketName?: string

                                                                                                                                                                                                                                                                              Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                              From ad5050b3639f814af999aa18df395cdb13196338 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 22 Sep 2025 17:54:42 +0000 Subject: [PATCH 57/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@272f25125f5b216cd3546bfa74?= =?UTF-8?q?b9e327861b2790=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- assets/main.js | 8 +- assets/style.css | 11 +- .../EmbeddedLinuxCodeBuildProjectStack.html | 126 ++++++++-------- ...beddedLinuxCodePipelineBaseImageStack.html | 130 ++++++++-------- classes/EmbeddedLinuxCodePipelineStack.html | 126 ++++++++-------- classes/PipelineResourcesStack.html | 142 +++++++++--------- enums/ProjectType.html | 20 +-- index.html | 2 +- .../EmbeddedLinuxCodeBuildProjectProps.html | 12 +- ...beddedLinuxCodePipelineBaseImageProps.html | 12 +- .../EmbeddedLinuxCodePipelineProps.html | 30 ++-- interfaces/PipelineResourcesProps.html | 14 +- 12 files changed, 313 insertions(+), 320 deletions(-) diff --git a/assets/main.js b/assets/main.js index 3effabb..64b80ab 100644 --- a/assets/main.js +++ b/assets/main.js @@ -1,9 +1,9 @@ "use strict"; window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse","folder":"Folder","search_index_not_available":"The search index is not available","search_no_results_found_for_0":"No results found for {0}","kind_1":"Project","kind_2":"Module","kind_4":"Namespace","kind_8":"Enumeration","kind_16":"Enumeration Member","kind_32":"Variable","kind_64":"Function","kind_128":"Class","kind_256":"Interface","kind_512":"Constructor","kind_1024":"Property","kind_2048":"Method","kind_4096":"Call Signature","kind_8192":"Index Signature","kind_16384":"Constructor Signature","kind_32768":"Parameter","kind_65536":"Type Literal","kind_131072":"Type Parameter","kind_262144":"Accessor","kind_524288":"Get Signature","kind_1048576":"Set Signature","kind_2097152":"Type Alias","kind_4194304":"Reference","kind_8388608":"Document"}; -"use strict";(()=>{var Je=Object.create;var he=Object.defineProperty;var Ke=Object.getOwnPropertyDescriptor;var Ge=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var Ze=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var et=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ge(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ke(e,i))||r.enumerable});return t};var tt=(t,e,n)=>(n=t!=null?Je(Xe(t)):{},et(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=Ze((me,ge)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,l],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(oc?d+=2:a==c&&(n+=r[l+1]*i[d+1],l+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),c=0;c1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof me=="object"?ge.exports=n():e.lunr=n()}(this,function(){return t})})()});var O,G={getItem(){return null},setItem(){}},K;try{K=localStorage,O=K}catch{K=G,O=G}var S={getItem:t=>O.getItem(t),setItem:(t,e)=>O.setItem(t,e),disableWritingLocalStorage(){O=G},disable(){localStorage.clear(),O=G},enable(){O=K}};window.TypeDoc||={disableWritingLocalStorage(){S.disableWritingLocalStorage()},disableLocalStorage:()=>{S.disable()},enableLocalStorage:()=>{S.enable()}};window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",search_index_not_available:"The search index is not available",search_no_results_found_for_0:"No results found for {0}",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var pe=[];function Y(t,e){pe.push({selector:e,constructor:t})}var X=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){pe.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!nt(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function nt(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var fe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var Ie=tt(ye(),1);async function R(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}var Z="closing",ae="tsd-overlay";function rt(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function it(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function xe(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Z)&&(t.classList.remove(Z),document.getElementById(ae)?.remove(),t.close(),it())}),t.addEventListener("cancel",n=>{n.preventDefault(),ve(t)}),e?.closeOnClick&&document.addEventListener("click",n=>{t.open&&!t.contains(n.target)&&ve(t)},!0)}function Ee(t){if(t.open)return;let e=document.createElement("div");e.id=ae,document.body.appendChild(e),t.showModal(),rt()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Z),t.classList.add(Z)}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var le={};function we(t){for(let e of t.split(/\s+/))if(le.hasOwnProperty(e)&&!le[e])return!0;return!1}var ee=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=S.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){S.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),le[`tsd-is-${this.el.name}`]=this.value,this.app.filterChanged(),this.app.updateIndexVisibility()}};var Le=0;async function Se(t,e){if(!window.searchData)return;let n=await R(window.searchData);t.data=n,t.index=Ie.Index.load(n.index),e.innerHTML=""}function _e(){let t=document.getElementById("tsd-search-trigger"),e=document.getElementById("tsd-search"),n=document.getElementById("tsd-search-input"),r=document.getElementById("tsd-search-results"),i=document.getElementById("tsd-search-script"),s=document.getElementById("tsd-search-status");if(!(t&&e&&n&&r&&i&&s))throw new Error("Search controls missing");let o={base:document.documentElement.dataset.base};o.base.endsWith("/")||(o.base+="/"),i.addEventListener("error",()=>{let a=window.translations.search_index_not_available;Pe(s,a)}),i.addEventListener("load",()=>{Se(o,s)}),Se(o,s),st({trigger:t,searchEl:e,results:r,field:n,status:s},o)}function st(t,e){let{field:n,results:r,searchEl:i,status:s,trigger:o}=t;xe(i,{closeOnClick:!0});function a(){Ee(i),n.setSelectionRange(0,n.value.length)}o.addEventListener("click",a),n.addEventListener("input",fe(()=>{ot(r,n,s,e)},200)),n.addEventListener("keydown",l=>{if(r.childElementCount===0||l.ctrlKey||l.metaKey||l.altKey)return;let d=n.getAttribute("aria-activedescendant"),f=d?document.getElementById(d):null;if(f){let p=!1,v=!1;switch(l.key){case"Home":case"End":case"ArrowLeft":case"ArrowRight":v=!0;break;case"ArrowDown":case"ArrowUp":p=l.shiftKey;break}(p||v)&&ke(n)}if(!l.shiftKey)switch(l.key){case"Enter":f?.querySelector("a")?.click();break;case"ArrowUp":Te(r,n,f,-1),l.preventDefault();break;case"ArrowDown":Te(r,n,f,1),l.preventDefault();break}});function c(){ke(n)}n.addEventListener("change",c),n.addEventListener("blur",c),n.addEventListener("click",c),document.body.addEventListener("keydown",l=>{if(l.altKey||l.metaKey||l.shiftKey)return;let d=l.ctrlKey&&l.key==="k",f=!l.ctrlKey&&!ct()&&l.key==="/";(d||f)&&(l.preventDefault(),a())})}function ot(t,e,n,r){if(!r.index||!r.data)return;t.innerHTML="",n.innerHTML="",Le+=1;let i=e.value.trim(),s;if(i){let a=i.split(" ").map(c=>c.length?`*${c}*`:"").join(" ");s=r.index.search(a).filter(({ref:c})=>{let l=r.data.rows[Number(c)].classes;return!l||!we(l)})}else s=[];if(s.length===0&&i){let a=window.translations.search_no_results_found_for_0.replace("{0}",` "${te(i)}" `);Pe(n,a);return}for(let a=0;ac.score-a.score);let o=Math.min(10,s.length);for(let a=0;a`,f=Ce(c.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(f+=` (score: ${s[a].score.toFixed(2)})`),c.parent&&(f=` - ${Ce(c.parent,i)}.${f}`);let p=document.createElement("li");p.id=`tsd-search:${Le}-${a}`,p.role="option",p.ariaSelected="false",p.classList.value=c.classes??"";let v=document.createElement("a");v.tabIndex=-1,v.href=r.base+c.url,v.innerHTML=d+`${f}`,p.append(v),t.appendChild(p)}}function Te(t,e,n,r){let i;if(r===1?i=n?.nextElementSibling||t.firstElementChild:i=n?.previousElementSibling||t.lastElementChild,i!==n){if(!i||i.role!=="option"){console.error("Option missing");return}i.ariaSelected="true",i.scrollIntoView({behavior:"smooth",block:"nearest"}),e.setAttribute("aria-activedescendant",i.id),n?.setAttribute("aria-selected","false")}}function ke(t){let e=t.getAttribute("aria-activedescendant");(e?document.getElementById(e):null)?.setAttribute("aria-selected","false"),t.setAttribute("aria-activedescendant","")}function Ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(te(t.substring(s,o)),`${te(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(te(t.substring(s))),i.join("")}var at={"&":"&","<":"<",">":">","'":"'",'"':"""};function te(t){return t.replace(/[&<>"'"]/g,e=>at[e])}function Pe(t,e){t.innerHTML=e?`
                                                                                                                                                                                                                                                                              ${e}
                                                                                                                                                                                                                                                                              `:""}var lt=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ct(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!lt.includes(t.type):!1}var D="mousedown",Oe="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,ut=!1,F=!1,Me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Me?"is-mobile":"not-mobile");Me&&"ontouchstart"in document.documentElement&&(ut=!0,D="touchstart",Oe="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Oe,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Fe(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Ne(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ne(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Ne(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(document.createElement("span")).textContent=t.text}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(document.createElement("span")).textContent=t.text}}var oe=document.documentElement.dataset.base;oe.endsWith("/")||(oe+="/");function Ve(){document.querySelector(".tsd-full-hierarchy")?dt():document.querySelector(".tsd-hierarchy")&&ht()}function dt(){document.addEventListener("click",r=>{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=mt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function ht(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Be),Be())}async function Be(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await R(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),pt(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function pt(t,e,n){let r=e.roots.filter(i=>ft(e,i,n));for(let i of r)t.appendChild($e(e,i,n))}function $e(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let c=t.reflections[a],l=s.appendChild(document.createElement("a"));l.textContent=c.name,l.href=oe+c.url,l.className=c.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=oe+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let c=$e(t,a,n,r);c&&o.appendChild(c)}}return r.delete(e),s}function ft(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function mt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.setAttribute("viewBox","0 0 24 24"),t.setAttribute("fill","none"),t.innerHTML='',t}Y(re,"a[data-toggle]");Y(ie,".tsd-accordion");Y(ee,".tsd-filter-item input[type=checkbox]");var je=document.getElementById("tsd-theme");je&&He(je);var gt=new X;Object.defineProperty(window,"app",{value:gt});_e();Fe();Ve();"virtualKeyboard"in navigator&&(navigator.virtualKeyboard.overlaysContent=!0);})(); +"use strict";(()=>{var Ke=Object.create;var he=Object.defineProperty;var Ge=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var et=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var tt=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ze(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ge(e,i))||r.enumerable});return t};var nt=(t,e,n)=>(n=t!=null?Ke(Xe(t)):{},tt(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=et((me,ge)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=(function(e){return function(n){e.console&&console.warn&&console.warn(n)}})(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,l],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(oc?d+=2:a==c&&(n+=r[l+1]*i[d+1],l+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),c=0;c1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},(function(e,n){typeof define=="function"&&define.amd?define(n):typeof me=="object"?ge.exports=n():e.lunr=n()})(this,function(){return t})})()});var M,G={getItem(){return null},setItem(){}},K;try{K=localStorage,M=K}catch{K=G,M=G}var S={getItem:t=>M.getItem(t),setItem:(t,e)=>M.setItem(t,e),disableWritingLocalStorage(){M=G},disable(){localStorage.clear(),M=G},enable(){M=K}};window.TypeDoc||={disableWritingLocalStorage(){S.disableWritingLocalStorage()},disableLocalStorage:()=>{S.disable()},enableLocalStorage:()=>{S.enable()}};window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",search_index_not_available:"The search index is not available",search_no_results_found_for_0:"No results found for {0}",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var pe=[];function X(t,e){pe.push({selector:e,constructor:t})}var Z=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){pe.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!rt(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function rt(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var fe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var Ie=nt(ye(),1);async function R(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}var Y="closing",ae="tsd-overlay";function it(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function st(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function xe(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Y)&&(t.classList.remove(Y),document.getElementById(ae)?.remove(),t.close(),st())}),t.addEventListener("cancel",n=>{n.preventDefault(),ve(t)}),e?.closeOnClick&&document.addEventListener("click",n=>{t.open&&!t.contains(n.target)&&ve(t)},!0)}function Ee(t){if(t.open)return;let e=document.createElement("div");e.id=ae,document.body.appendChild(e),t.showModal(),it()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Y),t.classList.add(Y)}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var le={};function we(t){for(let e of t.split(/\s+/))if(le.hasOwnProperty(e)&&!le[e])return!0;return!1}var ee=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=S.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){S.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),le[`tsd-is-${this.el.name}`]=this.value,this.app.filterChanged(),this.app.updateIndexVisibility()}};var Le=0;async function Se(t,e){if(!window.searchData)return;let n=await R(window.searchData);t.data=n,t.index=Ie.Index.load(n.index),e.innerHTML=""}function _e(){let t=document.getElementById("tsd-search-trigger"),e=document.getElementById("tsd-search"),n=document.getElementById("tsd-search-input"),r=document.getElementById("tsd-search-results"),i=document.getElementById("tsd-search-script"),s=document.getElementById("tsd-search-status");if(!(t&&e&&n&&r&&i&&s))throw new Error("Search controls missing");let o={base:document.documentElement.dataset.base};o.base.endsWith("/")||(o.base+="/"),i.addEventListener("error",()=>{let a=window.translations.search_index_not_available;Pe(s,a)}),i.addEventListener("load",()=>{Se(o,s)}),Se(o,s),ot({trigger:t,searchEl:e,results:r,field:n,status:s},o)}function ot(t,e){let{field:n,results:r,searchEl:i,status:s,trigger:o}=t;xe(i,{closeOnClick:!0});function a(){Ee(i),n.setSelectionRange(0,n.value.length)}o.addEventListener("click",a),n.addEventListener("input",fe(()=>{at(r,n,s,e)},200)),n.addEventListener("keydown",l=>{if(r.childElementCount===0||l.ctrlKey||l.metaKey||l.altKey)return;let d=n.getAttribute("aria-activedescendant"),f=d?document.getElementById(d):null;if(f){let p=!1,v=!1;switch(l.key){case"Home":case"End":case"ArrowLeft":case"ArrowRight":v=!0;break;case"ArrowDown":case"ArrowUp":p=l.shiftKey;break}(p||v)&&ke(n)}if(!l.shiftKey)switch(l.key){case"Enter":f?.querySelector("a")?.click();break;case"ArrowUp":Te(r,n,f,-1),l.preventDefault();break;case"ArrowDown":Te(r,n,f,1),l.preventDefault();break}});function c(){ke(n)}n.addEventListener("change",c),n.addEventListener("blur",c),n.addEventListener("click",c),document.body.addEventListener("keydown",l=>{if(l.altKey||l.metaKey||l.shiftKey)return;let d=l.ctrlKey&&l.key==="k",f=!l.ctrlKey&&!ut()&&l.key==="/";(d||f)&&(l.preventDefault(),a())})}function at(t,e,n,r){if(!r.index||!r.data)return;t.innerHTML="",n.innerHTML="",Le+=1;let i=e.value.trim(),s;if(i){let a=i.split(" ").map(c=>c.length?`*${c}*`:"").join(" ");s=r.index.search(a).filter(({ref:c})=>{let l=r.data.rows[Number(c)].classes;return!l||!we(l)})}else s=[];if(s.length===0&&i){let a=window.translations.search_no_results_found_for_0.replace("{0}",` "${te(i)}" `);Pe(n,a);return}for(let a=0;ac.score-a.score);let o=Math.min(10,s.length);for(let a=0;a`,f=Ce(c.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(f+=` (score: ${s[a].score.toFixed(2)})`),c.parent&&(f=` + ${Ce(c.parent,i)}.${f}`);let p=document.createElement("li");p.id=`tsd-search:${Le}-${a}`,p.role="option",p.ariaSelected="false",p.classList.value=c.classes??"";let v=document.createElement("a");v.tabIndex=-1,v.href=r.base+c.url,v.innerHTML=d+`${f}`,p.append(v),t.appendChild(p)}}function Te(t,e,n,r){let i;if(r===1?i=n?.nextElementSibling||t.firstElementChild:i=n?.previousElementSibling||t.lastElementChild,i!==n){if(!i||i.role!=="option"){console.error("Option missing");return}i.ariaSelected="true",i.scrollIntoView({behavior:"smooth",block:"nearest"}),e.setAttribute("aria-activedescendant",i.id),n?.setAttribute("aria-selected","false")}}function ke(t){let e=t.getAttribute("aria-activedescendant");(e?document.getElementById(e):null)?.setAttribute("aria-selected","false"),t.setAttribute("aria-activedescendant","")}function Ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(te(t.substring(s,o)),`${te(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(te(t.substring(s))),i.join("")}var lt={"&":"&","<":"<",">":">","'":"'",'"':"""};function te(t){return t.replace(/[&<>"'"]/g,e=>lt[e])}function Pe(t,e){t.innerHTML=e?`
                                                                                                                                                                                                                                                                              ${e}
                                                                                                                                                                                                                                                                              `:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Be(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Be(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Be(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=gt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function pt(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Ve),Ve())}async function Ve(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await R(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),ft(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function ft(t,e,n){let r=e.roots.filter(i=>mt(e,i,n));for(let i of r)t.appendChild(je(e,i,n))}function je(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let c=t.reflections[a],l=s.appendChild(document.createElement("a"));l.textContent=c.name,l.href=oe+c.url,l.className=c.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=oe+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let c=je(t,a,n,r);c&&o.appendChild(c)}}return r.delete(e),s}function mt(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function gt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.setAttribute("viewBox","0 0 24 24"),t.setAttribute("fill","none"),t.innerHTML='',t}X(re,"a[data-toggle]");X(ie,".tsd-accordion");X(ee,".tsd-filter-item input[type=checkbox]");var qe=document.getElementById("tsd-theme");qe&&He(qe);var yt=new Z;Object.defineProperty(window,"app",{value:yt});_e();Ne();$e();"virtualKeyboard"in navigator&&(navigator.virtualKeyboard.overlaysContent=!0);})(); /*! Bundled license information: lunr/lunr.js: diff --git a/assets/style.css b/assets/style.css index 7c3fbdb..5ba5a2a 100644 --- a/assets/style.css +++ b/assets/style.css @@ -504,15 +504,8 @@ body { background: var(--color-background); font-family: - -apple-system, - BlinkMacSystemFont, - "Segoe UI", - "Noto Sans", - Helvetica, - Arial, - sans-serif, - "Apple Color Emoji", - "Segoe UI Emoji"; + -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; font-size: 16px; color: var(--color-text); margin: 0; diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 78e6a57..37af135 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                                                The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                                See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                • Stack
                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                constructor +

                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                • Stack
                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                constructor

                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                tags templateOptions region @@ -10,9 +10,9 @@ templateFile artifactId synthesizer -_versionReportingEnabled -_crossRegionReferences -_notificationArns? +_versionReportingEnabled +_crossRegionReferences +_notificationArns? node

                                                                                                                                                                                                                                                                                Accessors

                                                                                                                                                                                                                                                                                terminationProtection dependencies @@ -38,23 +38,23 @@ splitArn addTransform addMetadata -_addAssemblyDependency -_obtainAssemblyDependencies -_removeAssemblyDependency -_synthesizeTemplate +_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate regionalFact exportValue exportStringListValue allocateLogicalId -_validateId -_toCloudFormation +_validateId +_toCloudFormation addStackTag removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                region: string

                                                                                                                                                                                                                                                                                The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                region: string

                                                                                                                                                                                                                                                                                The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                1. The value provided to env.region when the stack is defined. This can @@ -71,7 +71,7 @@ into a region-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                account: string

                                                                                                                                                                                                                                                                                The AWS account into which this stack will be deployed.

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                account: string

                                                                                                                                                                                                                                                                                The AWS account into which this stack will be deployed.

                                                                                                                                                                                                                                                                                This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                1. The value provided to env.account when the stack is defined. This can @@ -88,7 +88,7 @@ into an account-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other account-agnostic behavior.

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                environment: string

                                                                                                                                                                                                                                                                                The environment coordinates in which this stack is deployed. In the form +

                                                                                                                                                                                                                                                                                environment: string

                                                                                                                                                                                                                                                                                The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

                                                                                                                                                                                                                                                                                You can use this value to determine if two stacks are targeting the same @@ -97,21 +97,21 @@ Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                nestedStackResource?: CfnResource

                                                                                                                                                                                                                                                                                If this is a nested stack, this represents its AWS::CloudFormation::Stack +

                                                                                                                                                                                                                                                                                nestedStackResource?: CfnResource

                                                                                                                                                                                                                                                                                If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                templateFile: string

                                                                                                                                                                                                                                                                                The name of the CloudFormation template file emitted to the output +

                                                                                                                                                                                                                                                                                templateFile: string

                                                                                                                                                                                                                                                                                The name of the CloudFormation template file emitted to the output directory during synthesis.

                                                                                                                                                                                                                                                                                Example value: MyStack.template.json

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                artifactId: string

                                                                                                                                                                                                                                                                                The ID of the cloud assembly artifact for this stack.

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                synthesizer: IStackSynthesizer

                                                                                                                                                                                                                                                                                Synthesis method for this stack

                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                Readonly Internal_versionReportingEnabled

                                                                                                                                                                                                                                                                                _versionReportingEnabled: boolean

                                                                                                                                                                                                                                                                                Whether version reporting is enabled for this stack

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                artifactId: string

                                                                                                                                                                                                                                                                                The ID of the cloud assembly artifact for this stack.

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                synthesizer: IStackSynthesizer

                                                                                                                                                                                                                                                                                Synthesis method for this stack

                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                Readonly Internal_versionReportingEnabled

                                                                                                                                                                                                                                                                                _versionReportingEnabled: boolean

                                                                                                                                                                                                                                                                                Whether version reporting is enabled for this stack

                                                                                                                                                                                                                                                                                Controls whether the CDK Metadata resource is injected

                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                _notificationArns?: string[]

                                                                                                                                                                                                                                                                                SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                node: Node

                                                                                                                                                                                                                                                                                The tree node.

                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                Accessors

                                                                                                                                                                                                                                                                                • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                  Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • value: boolean

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                  Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Returns Stack[]

                                                                                                                                                                                                                                                                                • get stackName(): string

                                                                                                                                                                                                                                                                                  The concrete CloudFormation physical stack name.

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                _notificationArns?: string[]

                                                                                                                                                                                                                                                                                SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                node: Node

                                                                                                                                                                                                                                                                                The tree node.

                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                Accessors

                                                                                                                                                                                                                                                                                • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                  Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • value: boolean

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                  Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Returns Stack[]

                                                                                                                                                                                                                                                                                • get stackName(): string

                                                                                                                                                                                                                                                                                  The concrete CloudFormation physical stack name.

                                                                                                                                                                                                                                                                                  This is either the name defined explicitly in the stackName prop or allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack @@ -119,15 +119,15 @@ scheme based on the construct path to ensure uniqueness.

                                                                                                                                                                                                                                                                                  If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                • get partition(): string

                                                                                                                                                                                                                                                                                  The partition in which this stack is defined

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                • get urlSuffix(): string

                                                                                                                                                                                                                                                                                  The Amazon domain suffix for the region in which this stack is defined

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                • get stackId(): string

                                                                                                                                                                                                                                                                                  The ID of the stack

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                • get partition(): string

                                                                                                                                                                                                                                                                                  The partition in which this stack is defined

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                • get urlSuffix(): string

                                                                                                                                                                                                                                                                                  The Amazon domain suffix for the region in which this stack is defined

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                • get stackId(): string

                                                                                                                                                                                                                                                                                  The ID of the stack

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                  // After resolving, looks like
                                                                                                                                                                                                                                                                                  'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
                                                                                                                                                                                                                                                                                • get notificationArns(): string[]

                                                                                                                                                                                                                                                                                  Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Returns string[]

                                                                                                                                                                                                                                                                                • get nested(): boolean

                                                                                                                                                                                                                                                                                  Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                • get availabilityZones(): string[]

                                                                                                                                                                                                                                                                                  Returns the list of AZs that are available in the AWS environment +

                                                                                                                                                                                                                                                                                  Returns string[]

                                                                                                                                                                                                                                                                                • get nested(): boolean

                                                                                                                                                                                                                                                                                  Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                • get availabilityZones(): string[]

                                                                                                                                                                                                                                                                                  Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

                                                                                                                                                                                                                                                                                  If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve @@ -137,23 +137,23 @@ reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

                                                                                                                                                                                                                                                                                  To specify a different strategy for selecting availability zones override this method.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Returns string[]

                                                                                                                                                                                                                                                                                • get nestedStackParent(): undefined | Stack

                                                                                                                                                                                                                                                                                  If this is a nested stack, returns it's parent stack.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Returns undefined | Stack

                                                                                                                                                                                                                                                                                • get bundlingRequired(): boolean

                                                                                                                                                                                                                                                                                  Indicates whether the stack requires bundling or not

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                • Return whether the given object is a Stack.

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Returns string[]

                                                                                                                                                                                                                                                                                • get nestedStackParent(): undefined | Stack

                                                                                                                                                                                                                                                                                  If this is a nested stack, returns it's parent stack.

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Returns undefined | Stack

                                                                                                                                                                                                                                                                                • get bundlingRequired(): boolean

                                                                                                                                                                                                                                                                                  Indicates whether the stack requires bundling or not

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                • Return whether the given object is a Stack.

                                                                                                                                                                                                                                                                                  We do attribute detection since we can't reliably use 'instanceof'.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • this: void
                                                                                                                                                                                                                                                                                  • x: any

                                                                                                                                                                                                                                                                                  Returns x is Stack

                                                                                                                                                                                                                                                                                • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • this: void
                                                                                                                                                                                                                                                                                  • x: any

                                                                                                                                                                                                                                                                                  Returns x is Stack

                                                                                                                                                                                                                                                                                • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • construct: IConstruct

                                                                                                                                                                                                                                                                                    The construct to start the search from.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                  Returns Stack

                                                                                                                                                                                                                                                                                • Resolve a tokenized value in the context of the current stack.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • obj: any

                                                                                                                                                                                                                                                                                  Returns any

                                                                                                                                                                                                                                                                                • Convert an object, potentially containing tokens, to a JSON string

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • this: void
                                                                                                                                                                                                                                                                                  • obj: any
                                                                                                                                                                                                                                                                                  • Optionalspace: number

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                • Convert an object, potentially containing tokens, to a YAML string

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • obj: any

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                • Indicate that a context key was expected

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                Returns Stack

                                                                                                                                                                                                                                                                                • Resolve a tokenized value in the context of the current stack.

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • obj: any

                                                                                                                                                                                                                                                                                  Returns any

                                                                                                                                                                                                                                                                                • Convert an object, potentially containing tokens, to a JSON string

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • this: void
                                                                                                                                                                                                                                                                                  • obj: any
                                                                                                                                                                                                                                                                                  • Optionalspace: number

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                • Convert an object, potentially containing tokens, to a YAML string

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • obj: any

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                • Indicate that a context key was expected

                                                                                                                                                                                                                                                                                  Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • report: MissingContext

                                                                                                                                                                                                                                                                                    The set of parameters needed to obtain the context

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                • Rename a generated logical identities

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                • Rename a generated logical identities

                                                                                                                                                                                                                                                                                  To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • oldId: string
                                                                                                                                                                                                                                                                                  • newId: string

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                • Allocates a stack-unique CloudFormation-compatible logical identity for a +

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • oldId: string
                                                                                                                                                                                                                                                                                  • newId: string

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                • Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.

                                                                                                                                                                                                                                                                                  This method is called when a CfnElement is created and used to render the initial logical identity of resources. Logical ID renames are applied at @@ -163,10 +163,10 @@ class and override this method.

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • element: CfnElement

                                                                                                                                                                                                                                                                                    The CloudFormation element for which a logical identity is needed.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                • Add a dependency between this stack and another stack.

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                                                • Add a dependency between this stack and another stack.

                                                                                                                                                                                                                                                                                  This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • target: Stack
                                                                                                                                                                                                                                                                                  • Optionalreason: string

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                • Creates an ARN from components.

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • target: Stack
                                                                                                                                                                                                                                                                                  • Optionalreason: string

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                • Creates an ARN from components.

                                                                                                                                                                                                                                                                                  If partition, region or account are not specified, the stack's partition, region and account will be used.

                                                                                                                                                                                                                                                                                  If any component is the empty string, an empty string will be inserted @@ -176,37 +176,37 @@

                                                                                                                                                                                                                                                                                  The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • components: ArnComponents

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                • Splits the provided ARN into its components. +

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • components: ArnComponents

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                • Splits the provided ARN into its components. Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • arn: string

                                                                                                                                                                                                                                                                                    the ARN to split into its components

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                  • arnFormat: ArnFormat

                                                                                                                                                                                                                                                                                    the expected format of 'arn' - depends on what format the service 'arn' represents uses

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                  Returns ArnComponents

                                                                                                                                                                                                                                                                                • Add a Transform to this stack. A Transform is a macro that AWS +

                                                                                                                                                                                                                                                                                • arnFormat: ArnFormat

                                                                                                                                                                                                                                                                                  the expected format of 'arn' - depends on what format the service 'arn' represents uses

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                Returns ArnComponents

                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

                                                                                                                                                                                                                                                                                declare const stack: Stack;

                                                                                                                                                                                                                                                                                stack.addTransform('AWS::Serverless-2016-10-31')

                                                                                                                                                                                                                                                                                _addAssemblyDependency

                                                                                                                                                                                                                                                                                • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
                                                                                                                                                                                                                                                                                  Internal

                                                                                                                                                                                                                                                                                  Called implicitly by the addDependency helper function in order to +

                                                                                                                                                                                                                                                                                _addAssemblyDependency

                                                                                                                                                                                                                                                                                • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
                                                                                                                                                                                                                                                                                  Internal

                                                                                                                                                                                                                                                                                  Called implicitly by the addDependency helper function in order to realize a dependency between two top-level stacks at the assembly level.

                                                                                                                                                                                                                                                                                  Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • target: Stack
                                                                                                                                                                                                                                                                                  • Optionalreason: StackDependencyReason

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                _obtainAssemblyDependencies

                                                                                                                                                                                                                                                                                • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
                                                                                                                                                                                                                                                                                  Internal

                                                                                                                                                                                                                                                                                  Called implicitly by the obtainDependencies helper function in order to +

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • target: Stack
                                                                                                                                                                                                                                                                                  • Optionalreason: StackDependencyReason

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                _obtainAssemblyDependencies

                                                                                                                                                                                                                                                                                • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
                                                                                                                                                                                                                                                                                  Internal

                                                                                                                                                                                                                                                                                  Called implicitly by the obtainDependencies helper function in order to collect resource dependencies across two top-level stacks at the assembly level.

                                                                                                                                                                                                                                                                                  Use stack.obtainDependencies to see the dependencies between any two stacks.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • reasonFilter: StackDependencyReason

                                                                                                                                                                                                                                                                                  Returns Element[]

                                                                                                                                                                                                                                                                                _removeAssemblyDependency

                                                                                                                                                                                                                                                                                • _removeAssemblyDependency(
                                                                                                                                                                                                                                                                                      target: Stack,
                                                                                                                                                                                                                                                                                      reasonFilter?: StackDependencyReason,
                                                                                                                                                                                                                                                                                  ): void
                                                                                                                                                                                                                                                                                  Internal

                                                                                                                                                                                                                                                                                  Called implicitly by the removeDependency helper function in order to +

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • reasonFilter: StackDependencyReason

                                                                                                                                                                                                                                                                                  Returns Element[]

                                                                                                                                                                                                                                                                                _removeAssemblyDependency

                                                                                                                                                                                                                                                                                • _removeAssemblyDependency(
                                                                                                                                                                                                                                                                                      target: Stack,
                                                                                                                                                                                                                                                                                      reasonFilter?: StackDependencyReason,
                                                                                                                                                                                                                                                                                  ): void
                                                                                                                                                                                                                                                                                  Internal

                                                                                                                                                                                                                                                                                  Called implicitly by the removeDependency helper function in order to remove a dependency between two top-level stacks at the assembly level.

                                                                                                                                                                                                                                                                                  Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • target: Stack
                                                                                                                                                                                                                                                                                  • OptionalreasonFilter: StackDependencyReason

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                _synthesizeTemplate

                                                                                                                                                                                                                                                                                • _synthesizeTemplate(
                                                                                                                                                                                                                                                                                      session: ISynthesisSession,
                                                                                                                                                                                                                                                                                      lookupRoleArn?: string,
                                                                                                                                                                                                                                                                                      lookupRoleExternalId?: string,
                                                                                                                                                                                                                                                                                      lookupRoleAdditionalOptions?: { [key: string]: any },
                                                                                                                                                                                                                                                                                  ): void
                                                                                                                                                                                                                                                                                  Internal

                                                                                                                                                                                                                                                                                  Synthesizes the cloudformation template into a cloud assembly.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • session: ISynthesisSession
                                                                                                                                                                                                                                                                                  • OptionallookupRoleArn: string
                                                                                                                                                                                                                                                                                  • OptionallookupRoleExternalId: string
                                                                                                                                                                                                                                                                                  • OptionallookupRoleAdditionalOptions: { [key: string]: any }

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                • Look up a fact value for the given fact for the region of this stack

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • target: Stack
                                                                                                                                                                                                                                                                                  • OptionalreasonFilter: StackDependencyReason

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                _synthesizeTemplate

                                                                                                                                                                                                                                                                                • _synthesizeTemplate(
                                                                                                                                                                                                                                                                                      session: ISynthesisSession,
                                                                                                                                                                                                                                                                                      lookupRoleArn?: string,
                                                                                                                                                                                                                                                                                      lookupRoleExternalId?: string,
                                                                                                                                                                                                                                                                                      lookupRoleAdditionalOptions?: { [key: string]: any },
                                                                                                                                                                                                                                                                                  ): void
                                                                                                                                                                                                                                                                                  Internal

                                                                                                                                                                                                                                                                                  Synthesizes the cloudformation template into a cloud assembly.

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • session: ISynthesisSession
                                                                                                                                                                                                                                                                                  • OptionallookupRoleArn: string
                                                                                                                                                                                                                                                                                  • OptionallookupRoleExternalId: string
                                                                                                                                                                                                                                                                                  • OptionallookupRoleAdditionalOptions: { [key: string]: any }

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                • Look up a fact value for the given fact for the region of this stack

                                                                                                                                                                                                                                                                                  Will return a definite value only if the region of the current stack is resolved. If not, a lookup map will be added to the stack and the lookup will be done at CDK deployment time.

                                                                                                                                                                                                                                                                                  @@ -219,7 +219,7 @@ not have to worry about regional facts.

                                                                                                                                                                                                                                                                                  If defaultValue is not given, it is an error if the fact is unknown for the given region.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • factName: string
                                                                                                                                                                                                                                                                                  • OptionaldefaultValue: string

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                • Create a CloudFormation Export for a string value

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • factName: string
                                                                                                                                                                                                                                                                                  • OptionaldefaultValue: string

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                • Create a CloudFormation Export for a string value

                                                                                                                                                                                                                                                                                  Returns a string representing the corresponding Fn.importValue() expression for this Export. You can control the name for the export by passing the name option.

                                                                                                                                                                                                                                                                                  @@ -255,7 +255,7 @@
                                                                                                                                                                                                                                                                                • Don't forget to remove the exportValue() call as well.
                                                                                                                                                                                                                                                                                • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                • exportedValue: any
                                                                                                                                                                                                                                                                                • Optionaloptions: ExportValueOptions

                                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                                                • Create a CloudFormation Export for a string list value

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • exportedValue: any
                                                                                                                                                                                                                                                                                  • Optionaloptions: ExportValueOptions

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                • Create a CloudFormation Export for a string list value

                                                                                                                                                                                                                                                                                  Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only @@ -270,7 +270,7 @@ remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

                                                                                                                                                                                                                                                                                  See exportValue for an example of this process.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • exportedValue: any
                                                                                                                                                                                                                                                                                  • Optionaloptions: ExportValueOptions

                                                                                                                                                                                                                                                                                  Returns string[]

                                                                                                                                                                                                                                                                                • Returns the naming scheme used to allocate logical IDs. By default, uses +

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • exportedValue: any
                                                                                                                                                                                                                                                                                  • Optionaloptions: ExportValueOptions

                                                                                                                                                                                                                                                                                  Returns string[]

                                                                                                                                                                                                                                                                                • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize this behavior.

                                                                                                                                                                                                                                                                                  In order to make sure logical IDs are unique and stable, we hash the resource @@ -302,16 +302,16 @@ part of the identifier.

                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                • cfnElement: CfnElement

                                                                                                                                                                                                                                                                                  The element for which the logical ID is allocated.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                                                Protected_validateId

                                                                                                                                                                                                                                                                                • _validateId(name: string): void
                                                                                                                                                                                                                                                                                  Internal

                                                                                                                                                                                                                                                                                  Validate stack name

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                                                Protected_validateId

                                                                                                                                                                                                                                                                                • _validateId(name: string): void
                                                                                                                                                                                                                                                                                  Internal

                                                                                                                                                                                                                                                                                  Validate stack name

                                                                                                                                                                                                                                                                                  CloudFormation stack names can include dashes in addition to the regular identifier character classes, and we don't allow one of the magic markers.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • name: string

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                Protected_toCloudFormation

                                                                                                                                                                                                                                                                                • _toCloudFormation(): any
                                                                                                                                                                                                                                                                                  Internal

                                                                                                                                                                                                                                                                                  Returns the CloudFormation template for this stack by traversing +

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • name: string

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                Protected_toCloudFormation

                                                                                                                                                                                                                                                                                • _toCloudFormation(): any
                                                                                                                                                                                                                                                                                  Internal

                                                                                                                                                                                                                                                                                  Returns the CloudFormation template for this stack by traversing the tree and invoking _toCloudFormation() on all Entity objects.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Returns any

                                                                                                                                                                                                                                                                                • Configure a stack tag

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Returns any

                                                                                                                                                                                                                                                                                • Configure a stack tag

                                                                                                                                                                                                                                                                                  At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • tagName: string
                                                                                                                                                                                                                                                                                  • tagValue: string

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                • Remove a stack tag

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • tagName: string
                                                                                                                                                                                                                                                                                  • tagValue: string

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                • Remove a stack tag

                                                                                                                                                                                                                                                                                  At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • tagName: string

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                • Checks if x is a construct.

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • tagName: string

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                • Checks if x is a construct.

                                                                                                                                                                                                                                                                                  Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

                                                                                                                                                                                                                                                                                  Explanation: in JavaScript, multiple copies of the constructs library on @@ -325,6 +325,6 @@ unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • x: any

                                                                                                                                                                                                                                                                                    Any object

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                  Returns x is Construct

                                                                                                                                                                                                                                                                                  true if x is an object created from a class which extends Construct.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                • Returns a string representation of this construct.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                Constructors
                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                Accessors
                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                Returns x is Construct

                                                                                                                                                                                                                                                                                true if x is an object created from a class which extends Construct.

                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                • Returns a string representation of this construct.

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                Constructors
                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                Accessors
                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 819c7f5..4327083 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                  Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                                                  The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                                                  For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                  • Stack
                                                                                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                                                  constructor +

                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                  • Stack
                                                                                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                                                  constructor

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  tags templateOptions region @@ -11,9 +11,9 @@ templateFile artifactId synthesizer -_versionReportingEnabled -_crossRegionReferences -_notificationArns? +_versionReportingEnabled +_crossRegionReferences +_notificationArns? ecrRepository ecrRepositoryImageTag node @@ -41,23 +41,23 @@ splitArn addTransform addMetadata -_addAssemblyDependency -_obtainAssemblyDependencies -_removeAssemblyDependency -_synthesizeTemplate +_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate regionalFact exportValue exportStringListValue allocateLogicalId -_validateId -_toCloudFormation +_validateId +_toCloudFormation addStackTag removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  tags: TagManager

                                                                                                                                                                                                                                                                                  Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                  Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  region: string

                                                                                                                                                                                                                                                                                  The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  tags: TagManager

                                                                                                                                                                                                                                                                                  Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                  Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  region: string

                                                                                                                                                                                                                                                                                  The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                  This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                  1. The value provided to env.region when the stack is defined. This can @@ -74,7 +74,7 @@ into a region-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                  account: string

                                                                                                                                                                                                                                                                                  The AWS account into which this stack will be deployed.

                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  account: string

                                                                                                                                                                                                                                                                                  The AWS account into which this stack will be deployed.

                                                                                                                                                                                                                                                                                  This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                  1. The value provided to env.account when the stack is defined. This can @@ -91,7 +91,7 @@ into an account-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other account-agnostic behavior.

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                  environment: string

                                                                                                                                                                                                                                                                                  The environment coordinates in which this stack is deployed. In the form +

                                                                                                                                                                                                                                                                                  environment: string

                                                                                                                                                                                                                                                                                  The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

                                                                                                                                                                                                                                                                                  You can use this value to determine if two stacks are targeting the same @@ -100,23 +100,23 @@ Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  nestedStackResource?: CfnResource

                                                                                                                                                                                                                                                                                  If this is a nested stack, this represents its AWS::CloudFormation::Stack +

                                                                                                                                                                                                                                                                                  nestedStackResource?: CfnResource

                                                                                                                                                                                                                                                                                  If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  templateFile: string

                                                                                                                                                                                                                                                                                  The name of the CloudFormation template file emitted to the output +

                                                                                                                                                                                                                                                                                  templateFile: string

                                                                                                                                                                                                                                                                                  The name of the CloudFormation template file emitted to the output directory during synthesis.

                                                                                                                                                                                                                                                                                  Example value: MyStack.template.json

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  artifactId: string

                                                                                                                                                                                                                                                                                  The ID of the cloud assembly artifact for this stack.

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  synthesizer: IStackSynthesizer

                                                                                                                                                                                                                                                                                  Synthesis method for this stack

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Readonly Internal_versionReportingEnabled

                                                                                                                                                                                                                                                                                  _versionReportingEnabled: boolean

                                                                                                                                                                                                                                                                                  Whether version reporting is enabled for this stack

                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  artifactId: string

                                                                                                                                                                                                                                                                                  The ID of the cloud assembly artifact for this stack.

                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  synthesizer: IStackSynthesizer

                                                                                                                                                                                                                                                                                  Synthesis method for this stack

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Readonly Internal_versionReportingEnabled

                                                                                                                                                                                                                                                                                  _versionReportingEnabled: boolean

                                                                                                                                                                                                                                                                                  Whether version reporting is enabled for this stack

                                                                                                                                                                                                                                                                                  Controls whether the CDK Metadata resource is injected

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                  _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                  Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                  _notificationArns?: string[]

                                                                                                                                                                                                                                                                                  SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                                                                                  The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                  The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  node: Node

                                                                                                                                                                                                                                                                                  The tree node.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Accessors

                                                                                                                                                                                                                                                                                  • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                    Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                                  • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • value: boolean

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                  • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                    Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Returns Stack[]

                                                                                                                                                                                                                                                                                  • get stackName(): string

                                                                                                                                                                                                                                                                                    The concrete CloudFormation physical stack name.

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                  Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                  _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                  Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                  _notificationArns?: string[]

                                                                                                                                                                                                                                                                                  SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                                                                                  The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                  The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  node: Node

                                                                                                                                                                                                                                                                                  The tree node.

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Accessors

                                                                                                                                                                                                                                                                                  • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                    Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                                  • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • value: boolean

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                  • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                    Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Returns Stack[]

                                                                                                                                                                                                                                                                                  • get stackName(): string

                                                                                                                                                                                                                                                                                    The concrete CloudFormation physical stack name.

                                                                                                                                                                                                                                                                                    This is either the name defined explicitly in the stackName prop or allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack @@ -124,15 +124,15 @@ scheme based on the construct path to ensure uniqueness.

                                                                                                                                                                                                                                                                                    If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                  • get partition(): string

                                                                                                                                                                                                                                                                                    The partition in which this stack is defined

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                  • get urlSuffix(): string

                                                                                                                                                                                                                                                                                    The Amazon domain suffix for the region in which this stack is defined

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                  • get stackId(): string

                                                                                                                                                                                                                                                                                    The ID of the stack

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                  • get partition(): string

                                                                                                                                                                                                                                                                                    The partition in which this stack is defined

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                  • get urlSuffix(): string

                                                                                                                                                                                                                                                                                    The Amazon domain suffix for the region in which this stack is defined

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                  • get stackId(): string

                                                                                                                                                                                                                                                                                    The ID of the stack

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                    // After resolving, looks like
                                                                                                                                                                                                                                                                                    'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
                                                                                                                                                                                                                                                                                  • get notificationArns(): string[]

                                                                                                                                                                                                                                                                                    Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Returns string[]

                                                                                                                                                                                                                                                                                  • get nested(): boolean

                                                                                                                                                                                                                                                                                    Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                                  • get availabilityZones(): string[]

                                                                                                                                                                                                                                                                                    Returns the list of AZs that are available in the AWS environment +

                                                                                                                                                                                                                                                                                    Returns string[]

                                                                                                                                                                                                                                                                                  • get nested(): boolean

                                                                                                                                                                                                                                                                                    Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                                  • get availabilityZones(): string[]

                                                                                                                                                                                                                                                                                    Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

                                                                                                                                                                                                                                                                                    If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve @@ -142,23 +142,23 @@ reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

                                                                                                                                                                                                                                                                                    To specify a different strategy for selecting availability zones override this method.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Returns string[]

                                                                                                                                                                                                                                                                                  • get nestedStackParent(): undefined | Stack

                                                                                                                                                                                                                                                                                    If this is a nested stack, returns it's parent stack.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Returns undefined | Stack

                                                                                                                                                                                                                                                                                  • get bundlingRequired(): boolean

                                                                                                                                                                                                                                                                                    Indicates whether the stack requires bundling or not

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                  • Return whether the given object is a Stack.

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Returns string[]

                                                                                                                                                                                                                                                                                  • get nestedStackParent(): undefined | Stack

                                                                                                                                                                                                                                                                                    If this is a nested stack, returns it's parent stack.

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Returns undefined | Stack

                                                                                                                                                                                                                                                                                  • get bundlingRequired(): boolean

                                                                                                                                                                                                                                                                                    Indicates whether the stack requires bundling or not

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                  • Return whether the given object is a Stack.

                                                                                                                                                                                                                                                                                    We do attribute detection since we can't reliably use 'instanceof'.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • this: void
                                                                                                                                                                                                                                                                                    • x: any

                                                                                                                                                                                                                                                                                    Returns x is Stack

                                                                                                                                                                                                                                                                                  • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • this: void
                                                                                                                                                                                                                                                                                    • x: any

                                                                                                                                                                                                                                                                                    Returns x is Stack

                                                                                                                                                                                                                                                                                  • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • construct: IConstruct

                                                                                                                                                                                                                                                                                      The construct to start the search from.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                    Returns Stack

                                                                                                                                                                                                                                                                                  • Resolve a tokenized value in the context of the current stack.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • obj: any

                                                                                                                                                                                                                                                                                    Returns any

                                                                                                                                                                                                                                                                                  • Convert an object, potentially containing tokens, to a JSON string

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • this: void
                                                                                                                                                                                                                                                                                    • obj: any
                                                                                                                                                                                                                                                                                    • Optionalspace: number

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                  • Convert an object, potentially containing tokens, to a YAML string

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • obj: any

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                  • Indicate that a context key was expected

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                  Returns Stack

                                                                                                                                                                                                                                                                                  • Resolve a tokenized value in the context of the current stack.

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • obj: any

                                                                                                                                                                                                                                                                                    Returns any

                                                                                                                                                                                                                                                                                  • Convert an object, potentially containing tokens, to a JSON string

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • this: void
                                                                                                                                                                                                                                                                                    • obj: any
                                                                                                                                                                                                                                                                                    • Optionalspace: number

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                  • Convert an object, potentially containing tokens, to a YAML string

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • obj: any

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                  • Indicate that a context key was expected

                                                                                                                                                                                                                                                                                    Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • report: MissingContext

                                                                                                                                                                                                                                                                                      The set of parameters needed to obtain the context

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                  • Rename a generated logical identities

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                  • Rename a generated logical identities

                                                                                                                                                                                                                                                                                    To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • oldId: string
                                                                                                                                                                                                                                                                                    • newId: string

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                  • Allocates a stack-unique CloudFormation-compatible logical identity for a +

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • oldId: string
                                                                                                                                                                                                                                                                                    • newId: string

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                  • Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.

                                                                                                                                                                                                                                                                                    This method is called when a CfnElement is created and used to render the initial logical identity of resources. Logical ID renames are applied at @@ -168,10 +168,10 @@ class and override this method.

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • element: CfnElement

                                                                                                                                                                                                                                                                                      The CloudFormation element for which a logical identity is needed.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                  • Add a dependency between this stack and another stack.

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                  • Add a dependency between this stack and another stack.

                                                                                                                                                                                                                                                                                    This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • target: Stack
                                                                                                                                                                                                                                                                                    • Optionalreason: string

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                  • Creates an ARN from components.

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • target: Stack
                                                                                                                                                                                                                                                                                    • Optionalreason: string

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                  • Creates an ARN from components.

                                                                                                                                                                                                                                                                                    If partition, region or account are not specified, the stack's partition, region and account will be used.

                                                                                                                                                                                                                                                                                    If any component is the empty string, an empty string will be inserted @@ -181,37 +181,37 @@

                                                                                                                                                                                                                                                                                    The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • components: ArnComponents

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                  • Splits the provided ARN into its components. +

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • components: ArnComponents

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                  • Splits the provided ARN into its components. Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • arn: string

                                                                                                                                                                                                                                                                                      the ARN to split into its components

                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                    • arnFormat: ArnFormat

                                                                                                                                                                                                                                                                                      the expected format of 'arn' - depends on what format the service 'arn' represents uses

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                    Returns ArnComponents

                                                                                                                                                                                                                                                                                  • Add a Transform to this stack. A Transform is a macro that AWS +

                                                                                                                                                                                                                                                                                  • arnFormat: ArnFormat

                                                                                                                                                                                                                                                                                    the expected format of 'arn' - depends on what format the service 'arn' represents uses

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                  Returns ArnComponents

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                  https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

                                                                                                                                                                                                                                                                                  declare const stack: Stack;

                                                                                                                                                                                                                                                                                  stack.addTransform('AWS::Serverless-2016-10-31')

                                                                                                                                                                                                                                                                                  _addAssemblyDependency

                                                                                                                                                                                                                                                                                  • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
                                                                                                                                                                                                                                                                                    Internal

                                                                                                                                                                                                                                                                                    Called implicitly by the addDependency helper function in order to +

                                                                                                                                                                                                                                                                                  _addAssemblyDependency

                                                                                                                                                                                                                                                                                  • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
                                                                                                                                                                                                                                                                                    Internal

                                                                                                                                                                                                                                                                                    Called implicitly by the addDependency helper function in order to realize a dependency between two top-level stacks at the assembly level.

                                                                                                                                                                                                                                                                                    Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • target: Stack
                                                                                                                                                                                                                                                                                    • Optionalreason: StackDependencyReason

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                  _obtainAssemblyDependencies

                                                                                                                                                                                                                                                                                  • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
                                                                                                                                                                                                                                                                                    Internal

                                                                                                                                                                                                                                                                                    Called implicitly by the obtainDependencies helper function in order to +

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • target: Stack
                                                                                                                                                                                                                                                                                    • Optionalreason: StackDependencyReason

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                  _obtainAssemblyDependencies

                                                                                                                                                                                                                                                                                  • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
                                                                                                                                                                                                                                                                                    Internal

                                                                                                                                                                                                                                                                                    Called implicitly by the obtainDependencies helper function in order to collect resource dependencies across two top-level stacks at the assembly level.

                                                                                                                                                                                                                                                                                    Use stack.obtainDependencies to see the dependencies between any two stacks.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • reasonFilter: StackDependencyReason

                                                                                                                                                                                                                                                                                    Returns Element[]

                                                                                                                                                                                                                                                                                  _removeAssemblyDependency

                                                                                                                                                                                                                                                                                  • _removeAssemblyDependency(
                                                                                                                                                                                                                                                                                        target: Stack,
                                                                                                                                                                                                                                                                                        reasonFilter?: StackDependencyReason,
                                                                                                                                                                                                                                                                                    ): void
                                                                                                                                                                                                                                                                                    Internal

                                                                                                                                                                                                                                                                                    Called implicitly by the removeDependency helper function in order to +

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • reasonFilter: StackDependencyReason

                                                                                                                                                                                                                                                                                    Returns Element[]

                                                                                                                                                                                                                                                                                  _removeAssemblyDependency

                                                                                                                                                                                                                                                                                  • _removeAssemblyDependency(
                                                                                                                                                                                                                                                                                        target: Stack,
                                                                                                                                                                                                                                                                                        reasonFilter?: StackDependencyReason,
                                                                                                                                                                                                                                                                                    ): void
                                                                                                                                                                                                                                                                                    Internal

                                                                                                                                                                                                                                                                                    Called implicitly by the removeDependency helper function in order to remove a dependency between two top-level stacks at the assembly level.

                                                                                                                                                                                                                                                                                    Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • target: Stack
                                                                                                                                                                                                                                                                                    • OptionalreasonFilter: StackDependencyReason

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                  _synthesizeTemplate

                                                                                                                                                                                                                                                                                  • _synthesizeTemplate(
                                                                                                                                                                                                                                                                                        session: ISynthesisSession,
                                                                                                                                                                                                                                                                                        lookupRoleArn?: string,
                                                                                                                                                                                                                                                                                        lookupRoleExternalId?: string,
                                                                                                                                                                                                                                                                                        lookupRoleAdditionalOptions?: { [key: string]: any },
                                                                                                                                                                                                                                                                                    ): void
                                                                                                                                                                                                                                                                                    Internal

                                                                                                                                                                                                                                                                                    Synthesizes the cloudformation template into a cloud assembly.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • session: ISynthesisSession
                                                                                                                                                                                                                                                                                    • OptionallookupRoleArn: string
                                                                                                                                                                                                                                                                                    • OptionallookupRoleExternalId: string
                                                                                                                                                                                                                                                                                    • OptionallookupRoleAdditionalOptions: { [key: string]: any }

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                  • Look up a fact value for the given fact for the region of this stack

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • target: Stack
                                                                                                                                                                                                                                                                                    • OptionalreasonFilter: StackDependencyReason

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                  _synthesizeTemplate

                                                                                                                                                                                                                                                                                  • _synthesizeTemplate(
                                                                                                                                                                                                                                                                                        session: ISynthesisSession,
                                                                                                                                                                                                                                                                                        lookupRoleArn?: string,
                                                                                                                                                                                                                                                                                        lookupRoleExternalId?: string,
                                                                                                                                                                                                                                                                                        lookupRoleAdditionalOptions?: { [key: string]: any },
                                                                                                                                                                                                                                                                                    ): void
                                                                                                                                                                                                                                                                                    Internal

                                                                                                                                                                                                                                                                                    Synthesizes the cloudformation template into a cloud assembly.

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • session: ISynthesisSession
                                                                                                                                                                                                                                                                                    • OptionallookupRoleArn: string
                                                                                                                                                                                                                                                                                    • OptionallookupRoleExternalId: string
                                                                                                                                                                                                                                                                                    • OptionallookupRoleAdditionalOptions: { [key: string]: any }

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                  • Look up a fact value for the given fact for the region of this stack

                                                                                                                                                                                                                                                                                    Will return a definite value only if the region of the current stack is resolved. If not, a lookup map will be added to the stack and the lookup will be done at CDK deployment time.

                                                                                                                                                                                                                                                                                    @@ -224,7 +224,7 @@ not have to worry about regional facts.

                                                                                                                                                                                                                                                                                    If defaultValue is not given, it is an error if the fact is unknown for the given region.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • factName: string
                                                                                                                                                                                                                                                                                    • OptionaldefaultValue: string

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                  • Create a CloudFormation Export for a string value

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • factName: string
                                                                                                                                                                                                                                                                                    • OptionaldefaultValue: string

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                  • Create a CloudFormation Export for a string value

                                                                                                                                                                                                                                                                                    Returns a string representing the corresponding Fn.importValue() expression for this Export. You can control the name for the export by passing the name option.

                                                                                                                                                                                                                                                                                    @@ -260,7 +260,7 @@
                                                                                                                                                                                                                                                                                  • Don't forget to remove the exportValue() call as well.
                                                                                                                                                                                                                                                                                  • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • exportedValue: any
                                                                                                                                                                                                                                                                                  • Optionaloptions: ExportValueOptions

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                  • Create a CloudFormation Export for a string list value

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • exportedValue: any
                                                                                                                                                                                                                                                                                    • Optionaloptions: ExportValueOptions

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                  • Create a CloudFormation Export for a string list value

                                                                                                                                                                                                                                                                                    Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only @@ -275,7 +275,7 @@ remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

                                                                                                                                                                                                                                                                                    See exportValue for an example of this process.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • exportedValue: any
                                                                                                                                                                                                                                                                                    • Optionaloptions: ExportValueOptions

                                                                                                                                                                                                                                                                                    Returns string[]

                                                                                                                                                                                                                                                                                  • Returns the naming scheme used to allocate logical IDs. By default, uses +

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • exportedValue: any
                                                                                                                                                                                                                                                                                    • Optionaloptions: ExportValueOptions

                                                                                                                                                                                                                                                                                    Returns string[]

                                                                                                                                                                                                                                                                                  • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize this behavior.

                                                                                                                                                                                                                                                                                    In order to make sure logical IDs are unique and stable, we hash the resource @@ -307,16 +307,16 @@ part of the identifier.

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  • cfnElement: CfnElement

                                                                                                                                                                                                                                                                                    The element for which the logical ID is allocated.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                  Protected_validateId

                                                                                                                                                                                                                                                                                  • _validateId(name: string): void
                                                                                                                                                                                                                                                                                    Internal

                                                                                                                                                                                                                                                                                    Validate stack name

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                  Protected_validateId

                                                                                                                                                                                                                                                                                  • _validateId(name: string): void
                                                                                                                                                                                                                                                                                    Internal

                                                                                                                                                                                                                                                                                    Validate stack name

                                                                                                                                                                                                                                                                                    CloudFormation stack names can include dashes in addition to the regular identifier character classes, and we don't allow one of the magic markers.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • name: string

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                  Protected_toCloudFormation

                                                                                                                                                                                                                                                                                  • _toCloudFormation(): any
                                                                                                                                                                                                                                                                                    Internal

                                                                                                                                                                                                                                                                                    Returns the CloudFormation template for this stack by traversing +

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • name: string

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                  Protected_toCloudFormation

                                                                                                                                                                                                                                                                                  • _toCloudFormation(): any
                                                                                                                                                                                                                                                                                    Internal

                                                                                                                                                                                                                                                                                    Returns the CloudFormation template for this stack by traversing the tree and invoking _toCloudFormation() on all Entity objects.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Returns any

                                                                                                                                                                                                                                                                                  • Configure a stack tag

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Returns any

                                                                                                                                                                                                                                                                                  • Configure a stack tag

                                                                                                                                                                                                                                                                                    At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • tagName: string
                                                                                                                                                                                                                                                                                    • tagValue: string

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                  • Remove a stack tag

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • tagName: string
                                                                                                                                                                                                                                                                                    • tagValue: string

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                  • Remove a stack tag

                                                                                                                                                                                                                                                                                    At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • tagName: string

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                  • Checks if x is a construct.

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • tagName: string

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                  • Checks if x is a construct.

                                                                                                                                                                                                                                                                                    Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

                                                                                                                                                                                                                                                                                    Explanation: in JavaScript, multiple copies of the constructs library on @@ -330,6 +330,6 @@ unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • x: any

                                                                                                                                                                                                                                                                                      Any object

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                    Returns x is Construct

                                                                                                                                                                                                                                                                                    true if x is an object created from a class which extends Construct.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                  • Returns a string representation of this construct.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                  Constructors
                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                  Accessors
                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Returns x is Construct

                                                                                                                                                                                                                                                                                  true if x is an object created from a class which extends Construct.

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  • Returns a string representation of this construct.

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                  Constructors
                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                  Accessors
                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                  diff --git a/classes/EmbeddedLinuxCodePipelineStack.html b/classes/EmbeddedLinuxCodePipelineStack.html index 2e47465..f8ab78f 100644 --- a/classes/EmbeddedLinuxCodePipelineStack.html +++ b/classes/EmbeddedLinuxCodePipelineStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodePipelineStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                    Class EmbeddedLinuxCodePipelineStack

                                                                                                                                                                                                                                                                                    The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                                    See EmbeddedLinuxCodePipelineProps for configration options.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                    • Stack
                                                                                                                                                                                                                                                                                      • EmbeddedLinuxCodePipelineStack
                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                    constructor +

                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                    • Stack
                                                                                                                                                                                                                                                                                      • EmbeddedLinuxCodePipelineStack
                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                    constructor

                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                    tags templateOptions region @@ -10,9 +10,9 @@ templateFile artifactId synthesizer -_versionReportingEnabled -_crossRegionReferences -_notificationArns? +_versionReportingEnabled +_crossRegionReferences +_notificationArns? node

                                                                                                                                                                                                                                                                                    Accessors

                                                                                                                                                                                                                                                                                    terminationProtection dependencies @@ -38,23 +38,23 @@ splitArn addTransform addMetadata -_addAssemblyDependency -_obtainAssemblyDependencies -_removeAssemblyDependency -_synthesizeTemplate +_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate regionalFact exportValue exportStringListValue allocateLogicalId -_validateId -_toCloudFormation +_validateId +_toCloudFormation addStackTag removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                    tags: TagManager

                                                                                                                                                                                                                                                                                    Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                    Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    region: string

                                                                                                                                                                                                                                                                                    The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                    tags: TagManager

                                                                                                                                                                                                                                                                                    Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                    Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    region: string

                                                                                                                                                                                                                                                                                    The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                    This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                    1. The value provided to env.region when the stack is defined. This can @@ -71,7 +71,7 @@ into a region-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                    account: string

                                                                                                                                                                                                                                                                                    The AWS account into which this stack will be deployed.

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    account: string

                                                                                                                                                                                                                                                                                    The AWS account into which this stack will be deployed.

                                                                                                                                                                                                                                                                                    This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                    1. The value provided to env.account when the stack is defined. This can @@ -88,7 +88,7 @@ into an account-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other account-agnostic behavior.

                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                    environment: string

                                                                                                                                                                                                                                                                                    The environment coordinates in which this stack is deployed. In the form +

                                                                                                                                                                                                                                                                                    environment: string

                                                                                                                                                                                                                                                                                    The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

                                                                                                                                                                                                                                                                                    You can use this value to determine if two stacks are targeting the same @@ -97,21 +97,21 @@ Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    nestedStackResource?: CfnResource

                                                                                                                                                                                                                                                                                    If this is a nested stack, this represents its AWS::CloudFormation::Stack +

                                                                                                                                                                                                                                                                                    nestedStackResource?: CfnResource

                                                                                                                                                                                                                                                                                    If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    templateFile: string

                                                                                                                                                                                                                                                                                    The name of the CloudFormation template file emitted to the output +

                                                                                                                                                                                                                                                                                    templateFile: string

                                                                                                                                                                                                                                                                                    The name of the CloudFormation template file emitted to the output directory during synthesis.

                                                                                                                                                                                                                                                                                    Example value: MyStack.template.json

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    artifactId: string

                                                                                                                                                                                                                                                                                    The ID of the cloud assembly artifact for this stack.

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    synthesizer: IStackSynthesizer

                                                                                                                                                                                                                                                                                    Synthesis method for this stack

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Readonly Internal_versionReportingEnabled

                                                                                                                                                                                                                                                                                    _versionReportingEnabled: boolean

                                                                                                                                                                                                                                                                                    Whether version reporting is enabled for this stack

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    artifactId: string

                                                                                                                                                                                                                                                                                    The ID of the cloud assembly artifact for this stack.

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    synthesizer: IStackSynthesizer

                                                                                                                                                                                                                                                                                    Synthesis method for this stack

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Readonly Internal_versionReportingEnabled

                                                                                                                                                                                                                                                                                    _versionReportingEnabled: boolean

                                                                                                                                                                                                                                                                                    Whether version reporting is enabled for this stack

                                                                                                                                                                                                                                                                                    Controls whether the CDK Metadata resource is injected

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                    _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                    Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                    _notificationArns?: string[]

                                                                                                                                                                                                                                                                                    SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    node: Node

                                                                                                                                                                                                                                                                                    The tree node.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Accessors

                                                                                                                                                                                                                                                                                    • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                      Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                    • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • value: boolean

                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                    • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                      Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Returns Stack[]

                                                                                                                                                                                                                                                                                    • get stackName(): string

                                                                                                                                                                                                                                                                                      The concrete CloudFormation physical stack name.

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                    Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                    _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                    Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                    _notificationArns?: string[]

                                                                                                                                                                                                                                                                                    SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    node: Node

                                                                                                                                                                                                                                                                                    The tree node.

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Accessors

                                                                                                                                                                                                                                                                                    • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                      Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                    • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • value: boolean

                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                    • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                      Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Returns Stack[]

                                                                                                                                                                                                                                                                                    • get stackName(): string

                                                                                                                                                                                                                                                                                      The concrete CloudFormation physical stack name.

                                                                                                                                                                                                                                                                                      This is either the name defined explicitly in the stackName prop or allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack @@ -119,15 +119,15 @@ scheme based on the construct path to ensure uniqueness.

                                                                                                                                                                                                                                                                                      If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                    • get partition(): string

                                                                                                                                                                                                                                                                                      The partition in which this stack is defined

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                    • get urlSuffix(): string

                                                                                                                                                                                                                                                                                      The Amazon domain suffix for the region in which this stack is defined

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                    • get stackId(): string

                                                                                                                                                                                                                                                                                      The ID of the stack

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                    • get partition(): string

                                                                                                                                                                                                                                                                                      The partition in which this stack is defined

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                    • get urlSuffix(): string

                                                                                                                                                                                                                                                                                      The Amazon domain suffix for the region in which this stack is defined

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                    • get stackId(): string

                                                                                                                                                                                                                                                                                      The ID of the stack

                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                      // After resolving, looks like
                                                                                                                                                                                                                                                                                      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
                                                                                                                                                                                                                                                                                    • get notificationArns(): string[]

                                                                                                                                                                                                                                                                                      Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Returns string[]

                                                                                                                                                                                                                                                                                    • get nested(): boolean

                                                                                                                                                                                                                                                                                      Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                    • get availabilityZones(): string[]

                                                                                                                                                                                                                                                                                      Returns the list of AZs that are available in the AWS environment +

                                                                                                                                                                                                                                                                                      Returns string[]

                                                                                                                                                                                                                                                                                    • get nested(): boolean

                                                                                                                                                                                                                                                                                      Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                    • get availabilityZones(): string[]

                                                                                                                                                                                                                                                                                      Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

                                                                                                                                                                                                                                                                                      If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve @@ -137,23 +137,23 @@ reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

                                                                                                                                                                                                                                                                                      To specify a different strategy for selecting availability zones override this method.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Returns string[]

                                                                                                                                                                                                                                                                                    • get nestedStackParent(): undefined | Stack

                                                                                                                                                                                                                                                                                      If this is a nested stack, returns it's parent stack.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Returns undefined | Stack

                                                                                                                                                                                                                                                                                    • get bundlingRequired(): boolean

                                                                                                                                                                                                                                                                                      Indicates whether the stack requires bundling or not

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                    • Return whether the given object is a Stack.

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Returns string[]

                                                                                                                                                                                                                                                                                    • get nestedStackParent(): undefined | Stack

                                                                                                                                                                                                                                                                                      If this is a nested stack, returns it's parent stack.

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Returns undefined | Stack

                                                                                                                                                                                                                                                                                    • get bundlingRequired(): boolean

                                                                                                                                                                                                                                                                                      Indicates whether the stack requires bundling or not

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                    • Return whether the given object is a Stack.

                                                                                                                                                                                                                                                                                      We do attribute detection since we can't reliably use 'instanceof'.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • this: void
                                                                                                                                                                                                                                                                                      • x: any

                                                                                                                                                                                                                                                                                      Returns x is Stack

                                                                                                                                                                                                                                                                                    • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • this: void
                                                                                                                                                                                                                                                                                      • x: any

                                                                                                                                                                                                                                                                                      Returns x is Stack

                                                                                                                                                                                                                                                                                    • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • construct: IConstruct

                                                                                                                                                                                                                                                                                        The construct to start the search from.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                      Returns Stack

                                                                                                                                                                                                                                                                                    • Resolve a tokenized value in the context of the current stack.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • obj: any

                                                                                                                                                                                                                                                                                      Returns any

                                                                                                                                                                                                                                                                                    • Convert an object, potentially containing tokens, to a JSON string

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • this: void
                                                                                                                                                                                                                                                                                      • obj: any
                                                                                                                                                                                                                                                                                      • Optionalspace: number

                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                    • Convert an object, potentially containing tokens, to a YAML string

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • obj: any

                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                    • Indicate that a context key was expected

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                    Returns Stack

                                                                                                                                                                                                                                                                                    • Resolve a tokenized value in the context of the current stack.

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • obj: any

                                                                                                                                                                                                                                                                                      Returns any

                                                                                                                                                                                                                                                                                    • Convert an object, potentially containing tokens, to a JSON string

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • this: void
                                                                                                                                                                                                                                                                                      • obj: any
                                                                                                                                                                                                                                                                                      • Optionalspace: number

                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                    • Convert an object, potentially containing tokens, to a YAML string

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • obj: any

                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                    • Indicate that a context key was expected

                                                                                                                                                                                                                                                                                      Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • report: MissingContext

                                                                                                                                                                                                                                                                                        The set of parameters needed to obtain the context

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                    • Rename a generated logical identities

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                    • Rename a generated logical identities

                                                                                                                                                                                                                                                                                      To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • oldId: string
                                                                                                                                                                                                                                                                                      • newId: string

                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                    • Allocates a stack-unique CloudFormation-compatible logical identity for a +

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • oldId: string
                                                                                                                                                                                                                                                                                      • newId: string

                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                    • Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.

                                                                                                                                                                                                                                                                                      This method is called when a CfnElement is created and used to render the initial logical identity of resources. Logical ID renames are applied at @@ -163,10 +163,10 @@ class and override this method.

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • element: CfnElement

                                                                                                                                                                                                                                                                                        The CloudFormation element for which a logical identity is needed.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                    • Add a dependency between this stack and another stack.

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                    • Add a dependency between this stack and another stack.

                                                                                                                                                                                                                                                                                      This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • target: Stack
                                                                                                                                                                                                                                                                                      • Optionalreason: string

                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                    • Creates an ARN from components.

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • target: Stack
                                                                                                                                                                                                                                                                                      • Optionalreason: string

                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                    • Creates an ARN from components.

                                                                                                                                                                                                                                                                                      If partition, region or account are not specified, the stack's partition, region and account will be used.

                                                                                                                                                                                                                                                                                      If any component is the empty string, an empty string will be inserted @@ -176,37 +176,37 @@

                                                                                                                                                                                                                                                                                      The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • components: ArnComponents

                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                    • Splits the provided ARN into its components. +

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • components: ArnComponents

                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                    • Splits the provided ARN into its components. Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • arn: string

                                                                                                                                                                                                                                                                                        the ARN to split into its components

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                      • arnFormat: ArnFormat

                                                                                                                                                                                                                                                                                        the expected format of 'arn' - depends on what format the service 'arn' represents uses

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                      Returns ArnComponents

                                                                                                                                                                                                                                                                                    • Add a Transform to this stack. A Transform is a macro that AWS +

                                                                                                                                                                                                                                                                                    • arnFormat: ArnFormat

                                                                                                                                                                                                                                                                                      the expected format of 'arn' - depends on what format the service 'arn' represents uses

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                    Returns ArnComponents

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

                                                                                                                                                                                                                                                                                    declare const stack: Stack;

                                                                                                                                                                                                                                                                                    stack.addTransform('AWS::Serverless-2016-10-31')

                                                                                                                                                                                                                                                                                    _addAssemblyDependency

                                                                                                                                                                                                                                                                                    • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
                                                                                                                                                                                                                                                                                      Internal

                                                                                                                                                                                                                                                                                      Called implicitly by the addDependency helper function in order to +

                                                                                                                                                                                                                                                                                    _addAssemblyDependency

                                                                                                                                                                                                                                                                                    • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
                                                                                                                                                                                                                                                                                      Internal

                                                                                                                                                                                                                                                                                      Called implicitly by the addDependency helper function in order to realize a dependency between two top-level stacks at the assembly level.

                                                                                                                                                                                                                                                                                      Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • target: Stack
                                                                                                                                                                                                                                                                                      • Optionalreason: StackDependencyReason

                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                    _obtainAssemblyDependencies

                                                                                                                                                                                                                                                                                    • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
                                                                                                                                                                                                                                                                                      Internal

                                                                                                                                                                                                                                                                                      Called implicitly by the obtainDependencies helper function in order to +

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • target: Stack
                                                                                                                                                                                                                                                                                      • Optionalreason: StackDependencyReason

                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                    _obtainAssemblyDependencies

                                                                                                                                                                                                                                                                                    • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
                                                                                                                                                                                                                                                                                      Internal

                                                                                                                                                                                                                                                                                      Called implicitly by the obtainDependencies helper function in order to collect resource dependencies across two top-level stacks at the assembly level.

                                                                                                                                                                                                                                                                                      Use stack.obtainDependencies to see the dependencies between any two stacks.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • reasonFilter: StackDependencyReason

                                                                                                                                                                                                                                                                                      Returns Element[]

                                                                                                                                                                                                                                                                                    _removeAssemblyDependency

                                                                                                                                                                                                                                                                                    • _removeAssemblyDependency(
                                                                                                                                                                                                                                                                                          target: Stack,
                                                                                                                                                                                                                                                                                          reasonFilter?: StackDependencyReason,
                                                                                                                                                                                                                                                                                      ): void
                                                                                                                                                                                                                                                                                      Internal

                                                                                                                                                                                                                                                                                      Called implicitly by the removeDependency helper function in order to +

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • reasonFilter: StackDependencyReason

                                                                                                                                                                                                                                                                                      Returns Element[]

                                                                                                                                                                                                                                                                                    _removeAssemblyDependency

                                                                                                                                                                                                                                                                                    • _removeAssemblyDependency(
                                                                                                                                                                                                                                                                                          target: Stack,
                                                                                                                                                                                                                                                                                          reasonFilter?: StackDependencyReason,
                                                                                                                                                                                                                                                                                      ): void
                                                                                                                                                                                                                                                                                      Internal

                                                                                                                                                                                                                                                                                      Called implicitly by the removeDependency helper function in order to remove a dependency between two top-level stacks at the assembly level.

                                                                                                                                                                                                                                                                                      Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • target: Stack
                                                                                                                                                                                                                                                                                      • OptionalreasonFilter: StackDependencyReason

                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                    _synthesizeTemplate

                                                                                                                                                                                                                                                                                    • _synthesizeTemplate(
                                                                                                                                                                                                                                                                                          session: ISynthesisSession,
                                                                                                                                                                                                                                                                                          lookupRoleArn?: string,
                                                                                                                                                                                                                                                                                          lookupRoleExternalId?: string,
                                                                                                                                                                                                                                                                                          lookupRoleAdditionalOptions?: { [key: string]: any },
                                                                                                                                                                                                                                                                                      ): void
                                                                                                                                                                                                                                                                                      Internal

                                                                                                                                                                                                                                                                                      Synthesizes the cloudformation template into a cloud assembly.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • session: ISynthesisSession
                                                                                                                                                                                                                                                                                      • OptionallookupRoleArn: string
                                                                                                                                                                                                                                                                                      • OptionallookupRoleExternalId: string
                                                                                                                                                                                                                                                                                      • OptionallookupRoleAdditionalOptions: { [key: string]: any }

                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                    • Look up a fact value for the given fact for the region of this stack

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • target: Stack
                                                                                                                                                                                                                                                                                      • OptionalreasonFilter: StackDependencyReason

                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                    _synthesizeTemplate

                                                                                                                                                                                                                                                                                    • _synthesizeTemplate(
                                                                                                                                                                                                                                                                                          session: ISynthesisSession,
                                                                                                                                                                                                                                                                                          lookupRoleArn?: string,
                                                                                                                                                                                                                                                                                          lookupRoleExternalId?: string,
                                                                                                                                                                                                                                                                                          lookupRoleAdditionalOptions?: { [key: string]: any },
                                                                                                                                                                                                                                                                                      ): void
                                                                                                                                                                                                                                                                                      Internal

                                                                                                                                                                                                                                                                                      Synthesizes the cloudformation template into a cloud assembly.

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • session: ISynthesisSession
                                                                                                                                                                                                                                                                                      • OptionallookupRoleArn: string
                                                                                                                                                                                                                                                                                      • OptionallookupRoleExternalId: string
                                                                                                                                                                                                                                                                                      • OptionallookupRoleAdditionalOptions: { [key: string]: any }

                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                    • Look up a fact value for the given fact for the region of this stack

                                                                                                                                                                                                                                                                                      Will return a definite value only if the region of the current stack is resolved. If not, a lookup map will be added to the stack and the lookup will be done at CDK deployment time.

                                                                                                                                                                                                                                                                                      @@ -219,7 +219,7 @@ not have to worry about regional facts.

                                                                                                                                                                                                                                                                                      If defaultValue is not given, it is an error if the fact is unknown for the given region.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • factName: string
                                                                                                                                                                                                                                                                                      • OptionaldefaultValue: string

                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                    • Create a CloudFormation Export for a string value

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • factName: string
                                                                                                                                                                                                                                                                                      • OptionaldefaultValue: string

                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                    • Create a CloudFormation Export for a string value

                                                                                                                                                                                                                                                                                      Returns a string representing the corresponding Fn.importValue() expression for this Export. You can control the name for the export by passing the name option.

                                                                                                                                                                                                                                                                                      @@ -255,7 +255,7 @@
                                                                                                                                                                                                                                                                                    • Don't forget to remove the exportValue() call as well.
                                                                                                                                                                                                                                                                                    • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • exportedValue: any
                                                                                                                                                                                                                                                                                    • Optionaloptions: ExportValueOptions

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                    • Create a CloudFormation Export for a string list value

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • exportedValue: any
                                                                                                                                                                                                                                                                                      • Optionaloptions: ExportValueOptions

                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                    • Create a CloudFormation Export for a string list value

                                                                                                                                                                                                                                                                                      Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only @@ -270,7 +270,7 @@ remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

                                                                                                                                                                                                                                                                                      See exportValue for an example of this process.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • exportedValue: any
                                                                                                                                                                                                                                                                                      • Optionaloptions: ExportValueOptions

                                                                                                                                                                                                                                                                                      Returns string[]

                                                                                                                                                                                                                                                                                    • Returns the naming scheme used to allocate logical IDs. By default, uses +

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • exportedValue: any
                                                                                                                                                                                                                                                                                      • Optionaloptions: ExportValueOptions

                                                                                                                                                                                                                                                                                      Returns string[]

                                                                                                                                                                                                                                                                                    • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize this behavior.

                                                                                                                                                                                                                                                                                      In order to make sure logical IDs are unique and stable, we hash the resource @@ -302,16 +302,16 @@ part of the identifier.

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • cfnElement: CfnElement

                                                                                                                                                                                                                                                                                      The element for which the logical ID is allocated.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                    Protected_validateId

                                                                                                                                                                                                                                                                                    • _validateId(name: string): void
                                                                                                                                                                                                                                                                                      Internal

                                                                                                                                                                                                                                                                                      Validate stack name

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                    Protected_validateId

                                                                                                                                                                                                                                                                                    • _validateId(name: string): void
                                                                                                                                                                                                                                                                                      Internal

                                                                                                                                                                                                                                                                                      Validate stack name

                                                                                                                                                                                                                                                                                      CloudFormation stack names can include dashes in addition to the regular identifier character classes, and we don't allow one of the magic markers.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • name: string

                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                    Protected_toCloudFormation

                                                                                                                                                                                                                                                                                    • _toCloudFormation(): any
                                                                                                                                                                                                                                                                                      Internal

                                                                                                                                                                                                                                                                                      Returns the CloudFormation template for this stack by traversing +

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • name: string

                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                    Protected_toCloudFormation

                                                                                                                                                                                                                                                                                    • _toCloudFormation(): any
                                                                                                                                                                                                                                                                                      Internal

                                                                                                                                                                                                                                                                                      Returns the CloudFormation template for this stack by traversing the tree and invoking _toCloudFormation() on all Entity objects.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Returns any

                                                                                                                                                                                                                                                                                    • Configure a stack tag

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Returns any

                                                                                                                                                                                                                                                                                    • Configure a stack tag

                                                                                                                                                                                                                                                                                      At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • tagName: string
                                                                                                                                                                                                                                                                                      • tagValue: string

                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                    • Remove a stack tag

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • tagName: string
                                                                                                                                                                                                                                                                                      • tagValue: string

                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                    • Remove a stack tag

                                                                                                                                                                                                                                                                                      At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • tagName: string

                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                    • Checks if x is a construct.

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • tagName: string

                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                    • Checks if x is a construct.

                                                                                                                                                                                                                                                                                      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

                                                                                                                                                                                                                                                                                      Explanation: in JavaScript, multiple copies of the constructs library on @@ -325,6 +325,6 @@ unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • x: any

                                                                                                                                                                                                                                                                                        Any object

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                      Returns x is Construct

                                                                                                                                                                                                                                                                                      true if x is an object created from a class which extends Construct.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                    • Returns a string representation of this construct.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                    Constructors
                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                    Accessors
                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Returns x is Construct

                                                                                                                                                                                                                                                                                    true if x is an object created from a class which extends Construct.

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    • Returns a string representation of this construct.

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                    Constructors
                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                    Accessors
                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                    diff --git a/classes/PipelineResourcesStack.html b/classes/PipelineResourcesStack.html index 55802b5..620b806 100644 --- a/classes/PipelineResourcesStack.html +++ b/classes/PipelineResourcesStack.html @@ -1,5 +1,5 @@ -PipelineResourcesStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                    aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                      Class PipelineResourcesStack

                                                                                                                                                                                                                                                                                      Input (Source) data for our PipelineResourcesStack.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                      • Stack
                                                                                                                                                                                                                                                                                        • PipelineResourcesStack
                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                      constructor +PipelineResourcesStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                      aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                        Class PipelineResourcesStack

                                                                                                                                                                                                                                                                                        Input (Source) data for our PipelineResourcesStack.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                        • Stack
                                                                                                                                                                                                                                                                                          • PipelineResourcesStack
                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                        tags templateOptions region @@ -9,9 +9,9 @@ templateFile artifactId synthesizer -_versionReportingEnabled -_crossRegionReferences -_notificationArns? +_versionReportingEnabled +_crossRegionReferences +_notificationArns? vpc ecrRepository pipelineArtifactBucket @@ -44,23 +44,23 @@ splitArn addTransform addMetadata -_addAssemblyDependency -_obtainAssemblyDependencies -_removeAssemblyDependency -_synthesizeTemplate +_addAssemblyDependency +_obtainAssemblyDependencies +_removeAssemblyDependency +_synthesizeTemplate regionalFact exportValue exportStringListValue allocateLogicalId -_validateId -_toCloudFormation +_validateId +_toCloudFormation addStackTag removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                        Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        region: string

                                                                                                                                                                                                                                                                                        The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                        Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        region: string

                                                                                                                                                                                                                                                                                        The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                        This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                        1. The value provided to env.region when the stack is defined. This can @@ -77,7 +77,7 @@ into a region-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        account: string

                                                                                                                                                                                                                                                                                        The AWS account into which this stack will be deployed.

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        account: string

                                                                                                                                                                                                                                                                                        The AWS account into which this stack will be deployed.

                                                                                                                                                                                                                                                                                        This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                        1. The value provided to env.account when the stack is defined. This can @@ -94,7 +94,7 @@ into an account-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other account-agnostic behavior.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        environment: string

                                                                                                                                                                                                                                                                                        The environment coordinates in which this stack is deployed. In the form +

                                                                                                                                                                                                                                                                                        environment: string

                                                                                                                                                                                                                                                                                        The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

                                                                                                                                                                                                                                                                                        You can use this value to determine if two stacks are targeting the same @@ -103,28 +103,28 @@ Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        nestedStackResource?: CfnResource

                                                                                                                                                                                                                                                                                        If this is a nested stack, this represents its AWS::CloudFormation::Stack +

                                                                                                                                                                                                                                                                                        nestedStackResource?: CfnResource

                                                                                                                                                                                                                                                                                        If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        templateFile: string

                                                                                                                                                                                                                                                                                        The name of the CloudFormation template file emitted to the output +

                                                                                                                                                                                                                                                                                        templateFile: string

                                                                                                                                                                                                                                                                                        The name of the CloudFormation template file emitted to the output directory during synthesis.

                                                                                                                                                                                                                                                                                        Example value: MyStack.template.json

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        artifactId: string

                                                                                                                                                                                                                                                                                        The ID of the cloud assembly artifact for this stack.

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        synthesizer: IStackSynthesizer

                                                                                                                                                                                                                                                                                        Synthesis method for this stack

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Readonly Internal_versionReportingEnabled

                                                                                                                                                                                                                                                                                        _versionReportingEnabled: boolean

                                                                                                                                                                                                                                                                                        Whether version reporting is enabled for this stack

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        artifactId: string

                                                                                                                                                                                                                                                                                        The ID of the cloud assembly artifact for this stack.

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        synthesizer: IStackSynthesizer

                                                                                                                                                                                                                                                                                        Synthesis method for this stack

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Readonly Internal_versionReportingEnabled

                                                                                                                                                                                                                                                                                        _versionReportingEnabled: boolean

                                                                                                                                                                                                                                                                                        Whether version reporting is enabled for this stack

                                                                                                                                                                                                                                                                                        Controls whether the CDK Metadata resource is injected

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                        _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                        Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                        _notificationArns?: string[]

                                                                                                                                                                                                                                                                                        SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        vpc: IVpc

                                                                                                                                                                                                                                                                                        The VPC for the pipeline to reside in.

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        ecrRepository: IRepository

                                                                                                                                                                                                                                                                                        The respository to put the build host container in.

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                        The artifact bucket

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        pipelineSourceBucket: Bucket

                                                                                                                                                                                                                                                                                        The source bucket

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                        The output bucket

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        loggingBucket?: Bucket

                                                                                                                                                                                                                                                                                        The Cloudwatch logging bucket

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        encryptionKey: Key

                                                                                                                                                                                                                                                                                        The encryption key use across

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        node: Node

                                                                                                                                                                                                                                                                                        The tree node.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Accessors

                                                                                                                                                                                                                                                                                        • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                          Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                        • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • value: boolean

                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                        • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                          Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Returns Stack[]

                                                                                                                                                                                                                                                                                        • get stackName(): string

                                                                                                                                                                                                                                                                                          The concrete CloudFormation physical stack name.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                        Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                        _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                        Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                        _notificationArns?: string[]

                                                                                                                                                                                                                                                                                        SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        vpc: IVpc

                                                                                                                                                                                                                                                                                        The VPC for the pipeline to reside in.

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        ecrRepository: IRepository

                                                                                                                                                                                                                                                                                        The respository to put the build host container in.

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                        The artifact bucket

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        pipelineSourceBucket: Bucket

                                                                                                                                                                                                                                                                                        The source bucket

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                        The output bucket

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        loggingBucket?: Bucket

                                                                                                                                                                                                                                                                                        The Cloudwatch logging bucket

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        encryptionKey: Key

                                                                                                                                                                                                                                                                                        The encryption key use across

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        node: Node

                                                                                                                                                                                                                                                                                        The tree node.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Accessors

                                                                                                                                                                                                                                                                                        • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                          Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                        • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • value: boolean

                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                        • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                          Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Returns Stack[]

                                                                                                                                                                                                                                                                                        • get stackName(): string

                                                                                                                                                                                                                                                                                          The concrete CloudFormation physical stack name.

                                                                                                                                                                                                                                                                                          This is either the name defined explicitly in the stackName prop or allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack @@ -132,15 +132,15 @@ scheme based on the construct path to ensure uniqueness.

                                                                                                                                                                                                                                                                                          If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                        • get partition(): string

                                                                                                                                                                                                                                                                                          The partition in which this stack is defined

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                        • get urlSuffix(): string

                                                                                                                                                                                                                                                                                          The Amazon domain suffix for the region in which this stack is defined

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                        • get stackId(): string

                                                                                                                                                                                                                                                                                          The ID of the stack

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                        • get partition(): string

                                                                                                                                                                                                                                                                                          The partition in which this stack is defined

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                        • get urlSuffix(): string

                                                                                                                                                                                                                                                                                          The Amazon domain suffix for the region in which this stack is defined

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                        • get stackId(): string

                                                                                                                                                                                                                                                                                          The ID of the stack

                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                          // After resolving, looks like
                                                                                                                                                                                                                                                                                          'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
                                                                                                                                                                                                                                                                                        • get notificationArns(): string[]

                                                                                                                                                                                                                                                                                          Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Returns string[]

                                                                                                                                                                                                                                                                                        • get nested(): boolean

                                                                                                                                                                                                                                                                                          Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                        • get availabilityZones(): string[]

                                                                                                                                                                                                                                                                                          Returns the list of AZs that are available in the AWS environment +

                                                                                                                                                                                                                                                                                          Returns string[]

                                                                                                                                                                                                                                                                                        • get nested(): boolean

                                                                                                                                                                                                                                                                                          Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                        • get availabilityZones(): string[]

                                                                                                                                                                                                                                                                                          Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

                                                                                                                                                                                                                                                                                          If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve @@ -150,23 +150,23 @@ reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

                                                                                                                                                                                                                                                                                          To specify a different strategy for selecting availability zones override this method.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Returns string[]

                                                                                                                                                                                                                                                                                        • get nestedStackParent(): undefined | Stack

                                                                                                                                                                                                                                                                                          If this is a nested stack, returns it's parent stack.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Returns undefined | Stack

                                                                                                                                                                                                                                                                                        • get bundlingRequired(): boolean

                                                                                                                                                                                                                                                                                          Indicates whether the stack requires bundling or not

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                        • Return whether the given object is a Stack.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Returns string[]

                                                                                                                                                                                                                                                                                        • get nestedStackParent(): undefined | Stack

                                                                                                                                                                                                                                                                                          If this is a nested stack, returns it's parent stack.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Returns undefined | Stack

                                                                                                                                                                                                                                                                                        • get bundlingRequired(): boolean

                                                                                                                                                                                                                                                                                          Indicates whether the stack requires bundling or not

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                        • Return whether the given object is a Stack.

                                                                                                                                                                                                                                                                                          We do attribute detection since we can't reliably use 'instanceof'.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • this: void
                                                                                                                                                                                                                                                                                          • x: any

                                                                                                                                                                                                                                                                                          Returns x is Stack

                                                                                                                                                                                                                                                                                        • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • this: void
                                                                                                                                                                                                                                                                                          • x: any

                                                                                                                                                                                                                                                                                          Returns x is Stack

                                                                                                                                                                                                                                                                                        • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • construct: IConstruct

                                                                                                                                                                                                                                                                                            The construct to start the search from.

                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                          Returns Stack

                                                                                                                                                                                                                                                                                        • Resolve a tokenized value in the context of the current stack.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • obj: any

                                                                                                                                                                                                                                                                                          Returns any

                                                                                                                                                                                                                                                                                        • Convert an object, potentially containing tokens, to a JSON string

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • this: void
                                                                                                                                                                                                                                                                                          • obj: any
                                                                                                                                                                                                                                                                                          • Optionalspace: number

                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                        • Convert an object, potentially containing tokens, to a YAML string

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • obj: any

                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                        • Indicate that a context key was expected

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                        Returns Stack

                                                                                                                                                                                                                                                                                        • Resolve a tokenized value in the context of the current stack.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • obj: any

                                                                                                                                                                                                                                                                                          Returns any

                                                                                                                                                                                                                                                                                        • Convert an object, potentially containing tokens, to a JSON string

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • this: void
                                                                                                                                                                                                                                                                                          • obj: any
                                                                                                                                                                                                                                                                                          • Optionalspace: number

                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                        • Convert an object, potentially containing tokens, to a YAML string

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • obj: any

                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                        • Indicate that a context key was expected

                                                                                                                                                                                                                                                                                          Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • report: MissingContext

                                                                                                                                                                                                                                                                                            The set of parameters needed to obtain the context

                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                        • Rename a generated logical identities

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                        • Rename a generated logical identities

                                                                                                                                                                                                                                                                                          To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • oldId: string
                                                                                                                                                                                                                                                                                          • newId: string

                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                        • Allocates a stack-unique CloudFormation-compatible logical identity for a +

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • oldId: string
                                                                                                                                                                                                                                                                                          • newId: string

                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                        • Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.

                                                                                                                                                                                                                                                                                          This method is called when a CfnElement is created and used to render the initial logical identity of resources. Logical ID renames are applied at @@ -176,10 +176,10 @@ class and override this method.

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • element: CfnElement

                                                                                                                                                                                                                                                                                            The CloudFormation element for which a logical identity is needed.

                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                        • Add a dependency between this stack and another stack.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                                        • Add a dependency between this stack and another stack.

                                                                                                                                                                                                                                                                                          This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • target: Stack
                                                                                                                                                                                                                                                                                          • Optionalreason: string

                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                        • Creates an ARN from components.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • target: Stack
                                                                                                                                                                                                                                                                                          • Optionalreason: string

                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                        • Creates an ARN from components.

                                                                                                                                                                                                                                                                                          If partition, region or account are not specified, the stack's partition, region and account will be used.

                                                                                                                                                                                                                                                                                          If any component is the empty string, an empty string will be inserted @@ -189,37 +189,37 @@

                                                                                                                                                                                                                                                                                          The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • components: ArnComponents

                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                        • Splits the provided ARN into its components. +

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • components: ArnComponents

                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                        • Splits the provided ARN into its components. Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • arn: string

                                                                                                                                                                                                                                                                                            the ARN to split into its components

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • arnFormat: ArnFormat

                                                                                                                                                                                                                                                                                            the expected format of 'arn' - depends on what format the service 'arn' represents uses

                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                          Returns ArnComponents

                                                                                                                                                                                                                                                                                        • Add a Transform to this stack. A Transform is a macro that AWS +

                                                                                                                                                                                                                                                                                        • arnFormat: ArnFormat

                                                                                                                                                                                                                                                                                          the expected format of 'arn' - depends on what format the service 'arn' represents uses

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                        Returns ArnComponents

                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                        https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

                                                                                                                                                                                                                                                                                        declare const stack: Stack;

                                                                                                                                                                                                                                                                                        stack.addTransform('AWS::Serverless-2016-10-31')

                                                                                                                                                                                                                                                                                        _addAssemblyDependency

                                                                                                                                                                                                                                                                                        • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
                                                                                                                                                                                                                                                                                          Internal

                                                                                                                                                                                                                                                                                          Called implicitly by the addDependency helper function in order to +

                                                                                                                                                                                                                                                                                        _addAssemblyDependency

                                                                                                                                                                                                                                                                                        • _addAssemblyDependency(target: Stack, reason?: StackDependencyReason): void
                                                                                                                                                                                                                                                                                          Internal

                                                                                                                                                                                                                                                                                          Called implicitly by the addDependency helper function in order to realize a dependency between two top-level stacks at the assembly level.

                                                                                                                                                                                                                                                                                          Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • target: Stack
                                                                                                                                                                                                                                                                                          • Optionalreason: StackDependencyReason

                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                        _obtainAssemblyDependencies

                                                                                                                                                                                                                                                                                        • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
                                                                                                                                                                                                                                                                                          Internal

                                                                                                                                                                                                                                                                                          Called implicitly by the obtainDependencies helper function in order to +

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • target: Stack
                                                                                                                                                                                                                                                                                          • Optionalreason: StackDependencyReason

                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                        _obtainAssemblyDependencies

                                                                                                                                                                                                                                                                                        • _obtainAssemblyDependencies(reasonFilter: StackDependencyReason): Element[]
                                                                                                                                                                                                                                                                                          Internal

                                                                                                                                                                                                                                                                                          Called implicitly by the obtainDependencies helper function in order to collect resource dependencies across two top-level stacks at the assembly level.

                                                                                                                                                                                                                                                                                          Use stack.obtainDependencies to see the dependencies between any two stacks.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • reasonFilter: StackDependencyReason

                                                                                                                                                                                                                                                                                          Returns Element[]

                                                                                                                                                                                                                                                                                        _removeAssemblyDependency

                                                                                                                                                                                                                                                                                        • _removeAssemblyDependency(
                                                                                                                                                                                                                                                                                              target: Stack,
                                                                                                                                                                                                                                                                                              reasonFilter?: StackDependencyReason,
                                                                                                                                                                                                                                                                                          ): void
                                                                                                                                                                                                                                                                                          Internal

                                                                                                                                                                                                                                                                                          Called implicitly by the removeDependency helper function in order to +

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • reasonFilter: StackDependencyReason

                                                                                                                                                                                                                                                                                          Returns Element[]

                                                                                                                                                                                                                                                                                        _removeAssemblyDependency

                                                                                                                                                                                                                                                                                        • _removeAssemblyDependency(
                                                                                                                                                                                                                                                                                              target: Stack,
                                                                                                                                                                                                                                                                                              reasonFilter?: StackDependencyReason,
                                                                                                                                                                                                                                                                                          ): void
                                                                                                                                                                                                                                                                                          Internal

                                                                                                                                                                                                                                                                                          Called implicitly by the removeDependency helper function in order to remove a dependency between two top-level stacks at the assembly level.

                                                                                                                                                                                                                                                                                          Use stack.addDependency to define the dependency between any two stacks, and take into account nested stack relationships.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • target: Stack
                                                                                                                                                                                                                                                                                          • OptionalreasonFilter: StackDependencyReason

                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                        _synthesizeTemplate

                                                                                                                                                                                                                                                                                        • _synthesizeTemplate(
                                                                                                                                                                                                                                                                                              session: ISynthesisSession,
                                                                                                                                                                                                                                                                                              lookupRoleArn?: string,
                                                                                                                                                                                                                                                                                              lookupRoleExternalId?: string,
                                                                                                                                                                                                                                                                                              lookupRoleAdditionalOptions?: { [key: string]: any },
                                                                                                                                                                                                                                                                                          ): void
                                                                                                                                                                                                                                                                                          Internal

                                                                                                                                                                                                                                                                                          Synthesizes the cloudformation template into a cloud assembly.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • session: ISynthesisSession
                                                                                                                                                                                                                                                                                          • OptionallookupRoleArn: string
                                                                                                                                                                                                                                                                                          • OptionallookupRoleExternalId: string
                                                                                                                                                                                                                                                                                          • OptionallookupRoleAdditionalOptions: { [key: string]: any }

                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                        • Look up a fact value for the given fact for the region of this stack

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • target: Stack
                                                                                                                                                                                                                                                                                          • OptionalreasonFilter: StackDependencyReason

                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                        _synthesizeTemplate

                                                                                                                                                                                                                                                                                        • _synthesizeTemplate(
                                                                                                                                                                                                                                                                                              session: ISynthesisSession,
                                                                                                                                                                                                                                                                                              lookupRoleArn?: string,
                                                                                                                                                                                                                                                                                              lookupRoleExternalId?: string,
                                                                                                                                                                                                                                                                                              lookupRoleAdditionalOptions?: { [key: string]: any },
                                                                                                                                                                                                                                                                                          ): void
                                                                                                                                                                                                                                                                                          Internal

                                                                                                                                                                                                                                                                                          Synthesizes the cloudformation template into a cloud assembly.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • session: ISynthesisSession
                                                                                                                                                                                                                                                                                          • OptionallookupRoleArn: string
                                                                                                                                                                                                                                                                                          • OptionallookupRoleExternalId: string
                                                                                                                                                                                                                                                                                          • OptionallookupRoleAdditionalOptions: { [key: string]: any }

                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                        • Look up a fact value for the given fact for the region of this stack

                                                                                                                                                                                                                                                                                          Will return a definite value only if the region of the current stack is resolved. If not, a lookup map will be added to the stack and the lookup will be done at CDK deployment time.

                                                                                                                                                                                                                                                                                          @@ -232,7 +232,7 @@ not have to worry about regional facts.

                                                                                                                                                                                                                                                                                          If defaultValue is not given, it is an error if the fact is unknown for the given region.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • factName: string
                                                                                                                                                                                                                                                                                          • OptionaldefaultValue: string

                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                        • Create a CloudFormation Export for a string value

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • factName: string
                                                                                                                                                                                                                                                                                          • OptionaldefaultValue: string

                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                        • Create a CloudFormation Export for a string value

                                                                                                                                                                                                                                                                                          Returns a string representing the corresponding Fn.importValue() expression for this Export. You can control the name for the export by passing the name option.

                                                                                                                                                                                                                                                                                          @@ -268,7 +268,7 @@
                                                                                                                                                                                                                                                                                        • Don't forget to remove the exportValue() call as well.
                                                                                                                                                                                                                                                                                        • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        • exportedValue: any
                                                                                                                                                                                                                                                                                        • Optionaloptions: ExportValueOptions

                                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                                        • Create a CloudFormation Export for a string list value

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • exportedValue: any
                                                                                                                                                                                                                                                                                          • Optionaloptions: ExportValueOptions

                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                        • Create a CloudFormation Export for a string list value

                                                                                                                                                                                                                                                                                          Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only @@ -283,7 +283,7 @@ remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

                                                                                                                                                                                                                                                                                          See exportValue for an example of this process.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • exportedValue: any
                                                                                                                                                                                                                                                                                          • Optionaloptions: ExportValueOptions

                                                                                                                                                                                                                                                                                          Returns string[]

                                                                                                                                                                                                                                                                                        • Returns the naming scheme used to allocate logical IDs. By default, uses +

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • exportedValue: any
                                                                                                                                                                                                                                                                                          • Optionaloptions: ExportValueOptions

                                                                                                                                                                                                                                                                                          Returns string[]

                                                                                                                                                                                                                                                                                        • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize this behavior.

                                                                                                                                                                                                                                                                                          In order to make sure logical IDs are unique and stable, we hash the resource @@ -315,16 +315,16 @@ part of the identifier.

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        • cfnElement: CfnElement

                                                                                                                                                                                                                                                                                          The element for which the logical ID is allocated.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                                        Protected_validateId

                                                                                                                                                                                                                                                                                        • _validateId(name: string): void
                                                                                                                                                                                                                                                                                          Internal

                                                                                                                                                                                                                                                                                          Validate stack name

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                                        Protected_validateId

                                                                                                                                                                                                                                                                                        • _validateId(name: string): void
                                                                                                                                                                                                                                                                                          Internal

                                                                                                                                                                                                                                                                                          Validate stack name

                                                                                                                                                                                                                                                                                          CloudFormation stack names can include dashes in addition to the regular identifier character classes, and we don't allow one of the magic markers.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • name: string

                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                        Protected_toCloudFormation

                                                                                                                                                                                                                                                                                        • _toCloudFormation(): any
                                                                                                                                                                                                                                                                                          Internal

                                                                                                                                                                                                                                                                                          Returns the CloudFormation template for this stack by traversing +

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • name: string

                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                        Protected_toCloudFormation

                                                                                                                                                                                                                                                                                        • _toCloudFormation(): any
                                                                                                                                                                                                                                                                                          Internal

                                                                                                                                                                                                                                                                                          Returns the CloudFormation template for this stack by traversing the tree and invoking _toCloudFormation() on all Entity objects.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Returns any

                                                                                                                                                                                                                                                                                        • Configure a stack tag

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Returns any

                                                                                                                                                                                                                                                                                        • Configure a stack tag

                                                                                                                                                                                                                                                                                          At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • tagName: string
                                                                                                                                                                                                                                                                                          • tagValue: string

                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                        • Remove a stack tag

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • tagName: string
                                                                                                                                                                                                                                                                                          • tagValue: string

                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                        • Remove a stack tag

                                                                                                                                                                                                                                                                                          At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • tagName: string

                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                        • Checks if x is a construct.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • tagName: string

                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                        • Checks if x is a construct.

                                                                                                                                                                                                                                                                                          Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

                                                                                                                                                                                                                                                                                          Explanation: in JavaScript, multiple copies of the constructs library on @@ -338,6 +338,6 @@ unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • x: any

                                                                                                                                                                                                                                                                                            Any object

                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                          Returns x is Construct

                                                                                                                                                                                                                                                                                          true if x is an object created from a class which extends Construct.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                        • Returns a string representation of this construct.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                        Constructors
                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                        Accessors
                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Returns x is Construct

                                                                                                                                                                                                                                                                                        true if x is an object created from a class which extends Construct.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        • Returns a string representation of this construct.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                        Constructors
                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                        Accessors
                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                        diff --git a/enums/ProjectType.html b/enums/ProjectType.html index 222fe71..70d4042 100644 --- a/enums/ProjectType.html +++ b/enums/ProjectType.html @@ -1,6 +1,6 @@ ProjectType | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                        aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                          Enumeration ProjectType

                                                                                                                                                                                                                                                                                          The type of project built.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                          Enumeration Members

                                                                                                                                                                                                                                                                                          Poky -QEmu +
                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                          Enumeration Members

                                                                                                                                                                                                                                                                                          Poky +QEmu PokyAmi Kas Renesas @@ -8,11 +8,11 @@ CodeBuild Custom

                                                                                                                                                                                                                                                                                          Enumeration Members

                                                                                                                                                                                                                                                                                          Poky: "poky"

                                                                                                                                                                                                                                                                                          Build core-image-minimal from poky.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          QEmu: "qemu"

                                                                                                                                                                                                                                                                                          Build the Qemu meta-aws Demonstration Distribution.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          PokyAmi: "poky-ami"

                                                                                                                                                                                                                                                                                          Build an EC2 AMI

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          Kas: "kas"

                                                                                                                                                                                                                                                                                          Build an kas based image

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          Renesas: "renesas"

                                                                                                                                                                                                                                                                                          Build an Renesas image

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          NxpImx: "nxp-imx"

                                                                                                                                                                                                                                                                                          Build an IMX image using NXP layers.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          CodeBuild: "codebuild"

                                                                                                                                                                                                                                                                                          Build no pipeline, just CodeBuild project to connect with GitHub actions.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          Custom: "custom"

                                                                                                                                                                                                                                                                                          Build an image using a custom buildspec and asstes.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                          Enumeration Members
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          QEmu: "qemu"

                                                                                                                                                                                                                                                                                          Build the Qemu meta-aws Demonstration Distribution.

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          PokyAmi: "poky-ami"

                                                                                                                                                                                                                                                                                          Build an EC2 AMI

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Kas: "kas"

                                                                                                                                                                                                                                                                                          Build an kas based image

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Renesas: "renesas"

                                                                                                                                                                                                                                                                                          Build an Renesas image

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          NxpImx: "nxp-imx"

                                                                                                                                                                                                                                                                                          Build an IMX image using NXP layers.

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          CodeBuild: "codebuild"

                                                                                                                                                                                                                                                                                          Build no pipeline, just CodeBuild project to connect with GitHub actions.

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Custom: "custom"

                                                                                                                                                                                                                                                                                          Build an image using a custom buildspec and asstes.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                          Enumeration Members
                                                                                                                                                                                                                                                                                          diff --git a/index.html b/index.html index cab68dd..77fd639 100644 --- a/index.html +++ b/index.html @@ -230,4 +230,4 @@

                                                                                                                                                                                                                                                                                          This library is licensed under the MIT-0 License. See the LICENSE file.

                                                                                                                                                                                                                                                                                          Bask to the top

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                          aws4embeddedlinux-ci
                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                          aws4embeddedlinux-ci
                                                                                                                                                                                                                                                                                          diff --git a/interfaces/EmbeddedLinuxCodeBuildProjectProps.html b/interfaces/EmbeddedLinuxCodeBuildProjectProps.html index f8a684a..6a39459 100644 --- a/interfaces/EmbeddedLinuxCodeBuildProjectProps.html +++ b/interfaces/EmbeddedLinuxCodeBuildProjectProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodeBuildProjectProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                          aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                            Interface EmbeddedLinuxCodeBuildProjectProps

                                                                                                                                                                                                                                                                                            Properties to allow customizing the build.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            interface EmbeddedLinuxCodeBuildProjectProps {
                                                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                vpc: IVpc;
                                                                                                                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                encryptionKey: Key;
                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                                                                                                              • EmbeddedLinuxCodeBuildProjectProps
                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                            description? +
                                                                                                                                                                                                                                                                                            interface EmbeddedLinuxCodeBuildProjectProps {
                                                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                vpc: IVpc;
                                                                                                                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                encryptionKey: Key;
                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                                                                                                              • EmbeddedLinuxCodeBuildProjectProps
                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                            description? env? stackName? tags? @@ -106,8 +106,8 @@
                                                                                                                                                                                                                                                                                            ecrRepository: IRepository

                                                                                                                                                                                                                                                                                            ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                            Tag for the Build Host Image

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            vpc: IVpc

                                                                                                                                                                                                                                                                                            VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            encryptionKey: Key

                                                                                                                                                                                                                                                                                            The encryption key use across

                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                            Tag for the Build Host Image

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            vpc: IVpc

                                                                                                                                                                                                                                                                                            VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                            Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            encryptionKey: Key

                                                                                                                                                                                                                                                                                            The encryption key use across

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                            diff --git a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html index 82aa798..5407db7 100644 --- a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineBaseImageProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                            aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                              Interface EmbeddedLinuxCodePipelineBaseImageProps

                                                                                                                                                                                                                                                                                              Select options for the BuildImageCodePipelineStack.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              interface EmbeddedLinuxCodePipelineBaseImageProps {
                                                                                                                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                                                                                                                  env?: Environment;
                                                                                                                                                                                                                                                                                                  stackName?: string;
                                                                                                                                                                                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                  notificationArns?: string[];
                                                                                                                                                                                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                  pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                  pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                  pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                  ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                  encryptionKey: Key;
                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                              • StackProps
                                                                                                                                                                                                                                                                                                • EmbeddedLinuxCodePipelineBaseImageProps
                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                              description? +
                                                                                                                                                                                                                                                                                              interface EmbeddedLinuxCodePipelineBaseImageProps {
                                                                                                                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                                                                                                                  env?: Environment;
                                                                                                                                                                                                                                                                                                  stackName?: string;
                                                                                                                                                                                                                                                                                                  tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                  notificationArns?: string[];
                                                                                                                                                                                                                                                                                                  synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                  terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                  analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                  crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                  permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                  suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                  propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                  pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                  pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                  pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                  ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                  encryptionKey: Key;
                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                              • StackProps
                                                                                                                                                                                                                                                                                                • EmbeddedLinuxCodePipelineBaseImageProps
                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                              description? env? stackName? tags? @@ -106,8 +106,8 @@
                                                                                                                                                                                                                                                                                              pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                                              The pipeline source bucket

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                              The pipeline source prefix

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                              Artifact bucket to use

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              ecrRepository: IRepository

                                                                                                                                                                                                                                                                                              The ECR Repository to push to.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              encryptionKey: Key

                                                                                                                                                                                                                                                                                              The encryption key use across

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                              The pipeline source prefix

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                              Artifact bucket to use

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              ecrRepository: IRepository

                                                                                                                                                                                                                                                                                              The ECR Repository to push to.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              encryptionKey: Key

                                                                                                                                                                                                                                                                                              The encryption key use across

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                              diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 52a7352..9705ac3 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                                                                Properties to allow customizing the build.

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                    description?: string;
                                                                                                                                                                                                                                                                                                    env?: Environment;
                                                                                                                                                                                                                                                                                                    stackName?: string;
                                                                                                                                                                                                                                                                                                    tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                    notificationArns?: string[];
                                                                                                                                                                                                                                                                                                    synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                    terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                    analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                    crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                    permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                    suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                    propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                    pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                    pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                    pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                    pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                    pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                    pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                    ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                    ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                    projectType: ProjectType;
                                                                                                                                                                                                                                                                                                    vpc: IVpc;
                                                                                                                                                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                    encryptionKey: Key;
                                                                                                                                                                                                                                                                                                    sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                • StackProps
                                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                description? +
                                                                                                                                                                                                                                                                                                interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                    description?: string;
                                                                                                                                                                                                                                                                                                    env?: Environment;
                                                                                                                                                                                                                                                                                                    stackName?: string;
                                                                                                                                                                                                                                                                                                    tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                    notificationArns?: string[];
                                                                                                                                                                                                                                                                                                    synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                    terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                    analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                    crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                    permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                    suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                    propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                    pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                    pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                    pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                    pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                    pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                    pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                    ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                    ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                    projectType: ProjectType;
                                                                                                                                                                                                                                                                                                    vpc: IVpc;
                                                                                                                                                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                    encryptionKey: Key;
                                                                                                                                                                                                                                                                                                    sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                • StackProps
                                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                                                                pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                                                The pipeline source bucket

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                The pipeline source prefix

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                projectType: ProjectType

                                                                                                                                                                                                                                                                                                The type of project being built.

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                vpc: IVpc

                                                                                                                                                                                                                                                                                                VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                encryptionKey: Key

                                                                                                                                                                                                                                                                                                The encryption key use across

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                The pipeline source prefix

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                projectType: ProjectType

                                                                                                                                                                                                                                                                                                The type of project being built.

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                vpc: IVpc

                                                                                                                                                                                                                                                                                                VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                encryptionKey: Key

                                                                                                                                                                                                                                                                                                The encryption key use across

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 17e627e..c47fe8f 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                  Interface PipelineResourcesProps

                                                                                                                                                                                                                                                                                                  Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                      env?: Environment;
                                                                                                                                                                                                                                                                                                      stackName?: string;
                                                                                                                                                                                                                                                                                                      tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                      notificationArns?: string[];
                                                                                                                                                                                                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                      terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                      analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                      propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                      resource_prefix: string;
                                                                                                                                                                                                                                                                                                      ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                      pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                      pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                      pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                      loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                  • StackProps
                                                                                                                                                                                                                                                                                                    • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                  description? +
                                                                                                                                                                                                                                                                                                  interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                      env?: Environment;
                                                                                                                                                                                                                                                                                                      stackName?: string;
                                                                                                                                                                                                                                                                                                      tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                      notificationArns?: string[];
                                                                                                                                                                                                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                      terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                      analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                      propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                      resource_prefix: string;
                                                                                                                                                                                                                                                                                                      ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                      pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                      pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                      pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                      loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                  • StackProps
                                                                                                                                                                                                                                                                                                    • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                  description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                                                                  resource_prefix: string

                                                                                                                                                                                                                                                                                                  The resource prefix

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                  The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                  The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                  The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                  The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  loggingBucketName?: string

                                                                                                                                                                                                                                                                                                  Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                  The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                  The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                  The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                  The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  loggingBucketName?: string

                                                                                                                                                                                                                                                                                                  Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                  From 58bb2af7fe013f3048d643614b4c705f74bd3b21 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 22 Sep 2025 18:00:04 +0000 Subject: [PATCH 58/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@19d2dbd38e4858fe47cb768c0e?= =?UTF-8?q?60f09bfc93fb0f=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 37af135..ec80239 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                    Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                                                                    The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                                                    See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                    • Stack
                                                                                                                                                                                                                                                                                                      • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                    constructor +

                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                    • Stack
                                                                                                                                                                                                                                                                                                      • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                    constructor

                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                    tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                    tags: TagManager

                                                                                                                                                                                                                                                                                                    Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                    tags: TagManager

                                                                                                                                                                                                                                                                                                    Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                    templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                    Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                    region: string

                                                                                                                                                                                                                                                                                                    The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                    This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                    diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 4327083..70c1ff2 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                    aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                      Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                                                                      The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                                                                      For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                      • Stack
                                                                                                                                                                                                                                                                                                        • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                      constructor +

                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                      • Stack
                                                                                                                                                                                                                                                                                                        • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                      constructor

                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                      tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                      tags: TagManager

                                                                                                                                                                                                                                                                                                      Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                      tags: TagManager

                                                                                                                                                                                                                                                                                                      Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                      templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                      Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                      region: string

                                                                                                                                                                                                                                                                                                      The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                      This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                      @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                                                                      Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                                      _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                                      Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                                      Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                                      _notificationArns?: string[]

                                                                                                                                                                                                                                                                                                      SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                                      ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                      The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                      ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                      The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                      node: Node

                                                                                                                                                                                                                                                                                                      The tree node.

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                      The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      node: Node

                                                                                                                                                                                                                                                                                                      The tree node.

                                                                                                                                                                                                                                                                                                      Accessors

                                                                                                                                                                                                                                                                                                      • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                                        Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                      • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                        • value: boolean

                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                      • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                                        Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                                        Returns Stack[]

                                                                                                                                                                                                                                                                                                      pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                      The pipeline source prefix

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                      Artifact bucket to use

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                      The ECR Repository to push to.

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      encryptionKey: Key

                                                                                                                                                                                                                                                                                                      The encryption key use across

                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                      diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 9705ac3..5e3b2d2 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                      aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                        Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                                                                        Properties to allow customizing the build.

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                            description?: string;
                                                                                                                                                                                                                                                                                                            env?: Environment;
                                                                                                                                                                                                                                                                                                            stackName?: string;
                                                                                                                                                                                                                                                                                                            tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                            notificationArns?: string[];
                                                                                                                                                                                                                                                                                                            synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                            terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                            analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                            crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                            permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                            suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                            propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                            pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                            pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                            pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                            pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                            pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                            pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                            ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                            ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                            projectType: ProjectType;
                                                                                                                                                                                                                                                                                                            vpc: IVpc;
                                                                                                                                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                            encryptionKey: Key;
                                                                                                                                                                                                                                                                                                            sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                        • StackProps
                                                                                                                                                                                                                                                                                                          • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                        description? +
                                                                                                                                                                                                                                                                                                        interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                            description?: string;
                                                                                                                                                                                                                                                                                                            env?: Environment;
                                                                                                                                                                                                                                                                                                            stackName?: string;
                                                                                                                                                                                                                                                                                                            tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                            notificationArns?: string[];
                                                                                                                                                                                                                                                                                                            synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                            terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                            analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                            crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                            permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                            suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                            propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                            pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                            pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                            pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                            pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                            pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                            pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                            ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                            ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                            projectType: ProjectType;
                                                                                                                                                                                                                                                                                                            vpc: IVpc;
                                                                                                                                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                            encryptionKey: Key;
                                                                                                                                                                                                                                                                                                            sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                        • StackProps
                                                                                                                                                                                                                                                                                                          • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                        description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                                                                        pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                                                        The pipeline source bucket

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                        The pipeline source prefix

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                        The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                        The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                        The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                        The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                        ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                        Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        projectType: ProjectType

                                                                                                                                                                                                                                                                                                        The type of project being built.

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        vpc: IVpc

                                                                                                                                                                                                                                                                                                        VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                        Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                        Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        encryptionKey: Key

                                                                                                                                                                                                                                                                                                        The encryption key use across

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                        Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                        The pipeline source prefix

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                        The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                        The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                        The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                        The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                        ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                        Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        projectType: ProjectType

                                                                                                                                                                                                                                                                                                        The type of project being built.

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        vpc: IVpc

                                                                                                                                                                                                                                                                                                        VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                        Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                        Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        encryptionKey: Key

                                                                                                                                                                                                                                                                                                        The encryption key use across

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                        Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                        diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index c47fe8f..10be839 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                        aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                          Interface PipelineResourcesProps

                                                                                                                                                                                                                                                                                                          Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                              env?: Environment;
                                                                                                                                                                                                                                                                                                              stackName?: string;
                                                                                                                                                                                                                                                                                                              tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                              notificationArns?: string[];
                                                                                                                                                                                                                                                                                                              synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                              terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                              analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                              crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                              permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                              suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                              propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                              resource_prefix: string;
                                                                                                                                                                                                                                                                                                              ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                              pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                              pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                              pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                              loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                          • StackProps
                                                                                                                                                                                                                                                                                                            • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          description? +
                                                                                                                                                                                                                                                                                                          interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                              env?: Environment;
                                                                                                                                                                                                                                                                                                              stackName?: string;
                                                                                                                                                                                                                                                                                                              tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                              notificationArns?: string[];
                                                                                                                                                                                                                                                                                                              synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                              terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                              analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                              crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                              permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                              suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                              propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                              resource_prefix: string;
                                                                                                                                                                                                                                                                                                              ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                              pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                              pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                              pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                              loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                          • StackProps
                                                                                                                                                                                                                                                                                                            • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                                                                          resource_prefix: string

                                                                                                                                                                                                                                                                                                          The resource prefix

                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                          The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                          The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                          The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                          The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          loggingBucketName?: string

                                                                                                                                                                                                                                                                                                          Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                          The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                          The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                          The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                          The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          loggingBucketName?: string

                                                                                                                                                                                                                                                                                                          Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                          From 7db84669a9cca4ac0f1fa573a639cd49ddc637b7 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 22 Sep 2025 18:00:08 +0000 Subject: [PATCH 59/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@7205048571aa14ced74d5ef1a6?= =?UTF-8?q?7375e9e3220564=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index ec80239..bef76e2 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                          aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                            Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                                                                            The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                                                            See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                            • Stack
                                                                                                                                                                                                                                                                                                              • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                            constructor +

                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                            • Stack
                                                                                                                                                                                                                                                                                                              • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                            constructor

                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                            tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                            tags: TagManager

                                                                                                                                                                                                                                                                                                            Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                            tags: TagManager

                                                                                                                                                                                                                                                                                                            Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                            templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                            Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                            region: string

                                                                                                                                                                                                                                                                                                            The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                            This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                            diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 70c1ff2..648978a 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                            aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                              Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                                                                              The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                                                                              For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                              • Stack
                                                                                                                                                                                                                                                                                                                • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                              constructor +

                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                              • Stack
                                                                                                                                                                                                                                                                                                                • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                              constructor

                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                              tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                              tags: TagManager

                                                                                                                                                                                                                                                                                                              Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                              tags: TagManager

                                                                                                                                                                                                                                                                                                              Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                              templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                              Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                              region: string

                                                                                                                                                                                                                                                                                                              The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                              This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                              @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                                                                              Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                                              _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                                              Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                                              Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                                              _notificationArns?: string[]

                                                                                                                                                                                                                                                                                                              SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                                              ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                              The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                              The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              node: Node

                                                                                                                                                                                                                                                                                                              The tree node.

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                              The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              node: Node

                                                                                                                                                                                                                                                                                                              The tree node.

                                                                                                                                                                                                                                                                                                              Accessors

                                                                                                                                                                                                                                                                                                              • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                                                Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                                                Returns boolean

                                                                                                                                                                                                                                                                                                              • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                • value: boolean

                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                              • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                                                Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                                                Returns Stack[]

                                                                                                                                                                                                                                                                                                              pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                              The pipeline source prefix

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                              Artifact bucket to use

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                              The ECR Repository to push to.

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              encryptionKey: Key

                                                                                                                                                                                                                                                                                                              The encryption key use across

                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                              diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 5e3b2d2..6faa612 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                                                                                Properties to allow customizing the build.

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                    description?: string;
                                                                                                                                                                                                                                                                                                                    env?: Environment;
                                                                                                                                                                                                                                                                                                                    stackName?: string;
                                                                                                                                                                                                                                                                                                                    tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                    notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                    synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                    terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                    analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                    crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                    permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                    suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                    propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                    pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                    pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                    pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                    pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                    pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                    pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                    ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                    ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                    projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                    vpc: IVpc;
                                                                                                                                                                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                    encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                    sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                • StackProps
                                                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                description? +
                                                                                                                                                                                                                                                                                                                interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                    description?: string;
                                                                                                                                                                                                                                                                                                                    env?: Environment;
                                                                                                                                                                                                                                                                                                                    stackName?: string;
                                                                                                                                                                                                                                                                                                                    tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                    notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                    synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                    terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                    analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                    crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                    permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                    suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                    propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                    pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                    pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                    pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                    pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                    pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                    pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                    ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                    ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                    projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                    vpc: IVpc;
                                                                                                                                                                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                    encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                    sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                • StackProps
                                                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                                                                                pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                                                                The pipeline source bucket

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                The pipeline source prefix

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                projectType: ProjectType

                                                                                                                                                                                                                                                                                                                The type of project being built.

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                vpc: IVpc

                                                                                                                                                                                                                                                                                                                VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                encryptionKey: Key

                                                                                                                                                                                                                                                                                                                The encryption key use across

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                The pipeline source prefix

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                projectType: ProjectType

                                                                                                                                                                                                                                                                                                                The type of project being built.

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                vpc: IVpc

                                                                                                                                                                                                                                                                                                                VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                encryptionKey: Key

                                                                                                                                                                                                                                                                                                                The encryption key use across

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 10be839..446a739 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                  Interface PipelineResourcesProps

                                                                                                                                                                                                                                                                                                                  Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                                      env?: Environment;
                                                                                                                                                                                                                                                                                                                      stackName?: string;
                                                                                                                                                                                                                                                                                                                      tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                      notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                      terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                      analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                      propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                      resource_prefix: string;
                                                                                                                                                                                                                                                                                                                      ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                      pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                      pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                      pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                      loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                  • StackProps
                                                                                                                                                                                                                                                                                                                    • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                  description? +
                                                                                                                                                                                                                                                                                                                  interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                                      env?: Environment;
                                                                                                                                                                                                                                                                                                                      stackName?: string;
                                                                                                                                                                                                                                                                                                                      tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                      notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                      terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                      analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                      propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                      resource_prefix: string;
                                                                                                                                                                                                                                                                                                                      ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                      pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                      pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                      pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                      loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                  • StackProps
                                                                                                                                                                                                                                                                                                                    • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                  description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                                                                                  resource_prefix: string

                                                                                                                                                                                                                                                                                                                  The resource prefix

                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                  The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                  The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                  The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                  The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                  Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                  The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                  The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                  The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                  The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                  Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                  From 5597365a576282aa9e794627c556e88521febfbf Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 22 Sep 2025 18:00:20 +0000 Subject: [PATCH 60/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@173def316f596967170e76a2b1?= =?UTF-8?q?a2a2dec28d6aaa=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index bef76e2..3ba192e 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                    Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                                                                                    The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                                                                    See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                    • Stack
                                                                                                                                                                                                                                                                                                                      • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                    constructor +

                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                    • Stack
                                                                                                                                                                                                                                                                                                                      • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                    constructor

                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                    tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                    tags: TagManager

                                                                                                                                                                                                                                                                                                                    Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                    tags: TagManager

                                                                                                                                                                                                                                                                                                                    Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                    templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                    Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                    region: string

                                                                                                                                                                                                                                                                                                                    The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                    This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                    diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 648978a..3204a64 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                    aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                      Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                                                                                      The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                                                                                      For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                      • Stack
                                                                                                                                                                                                                                                                                                                        • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                      constructor +

                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                      • Stack
                                                                                                                                                                                                                                                                                                                        • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                      constructor

                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                      tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                      tags: TagManager

                                                                                                                                                                                                                                                                                                                      Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                      tags: TagManager

                                                                                                                                                                                                                                                                                                                      Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                      templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                      Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                      region: string

                                                                                                                                                                                                                                                                                                                      The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                      This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                      @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                                                                                      Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                                                      _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                                                      Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                                                      Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                                                      _notificationArns?: string[]

                                                                                                                                                                                                                                                                                                                      SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                                                      ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                      The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                      ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                      The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                      node: Node

                                                                                                                                                                                                                                                                                                                      The tree node.

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                      The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      node: Node

                                                                                                                                                                                                                                                                                                                      The tree node.

                                                                                                                                                                                                                                                                                                                      Accessors

                                                                                                                                                                                                                                                                                                                      • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                                                        Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                      • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                        • value: boolean

                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                      • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                                                        Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                                                        Returns Stack[]

                                                                                                                                                                                                                                                                                                                      pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                      The pipeline source prefix

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                      Artifact bucket to use

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                      The ECR Repository to push to.

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      encryptionKey: Key

                                                                                                                                                                                                                                                                                                                      The encryption key use across

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                      diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 6faa612..9e6d37a 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                      aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                        Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                                                                                        Properties to allow customizing the build.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                            description?: string;
                                                                                                                                                                                                                                                                                                                            env?: Environment;
                                                                                                                                                                                                                                                                                                                            stackName?: string;
                                                                                                                                                                                                                                                                                                                            tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                            notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                            synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                            terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                            analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                            crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                            permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                            suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                            propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                            pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                            pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                            pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                            pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                            pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                            pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                            ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                            ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                            projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                            vpc: IVpc;
                                                                                                                                                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                            encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                            sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                        • StackProps
                                                                                                                                                                                                                                                                                                                          • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                        description? +
                                                                                                                                                                                                                                                                                                                        interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                            description?: string;
                                                                                                                                                                                                                                                                                                                            env?: Environment;
                                                                                                                                                                                                                                                                                                                            stackName?: string;
                                                                                                                                                                                                                                                                                                                            tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                            notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                            synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                            terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                            analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                            crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                            permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                            suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                            propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                            pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                            pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                            pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                            pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                            pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                            pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                            ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                            ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                            projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                            vpc: IVpc;
                                                                                                                                                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                            encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                            sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                        • StackProps
                                                                                                                                                                                                                                                                                                                          • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                        description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                                                                                        pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                                                                        The pipeline source bucket

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                        The pipeline source prefix

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                        The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                        The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                        The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                        The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                        ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                        Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        projectType: ProjectType

                                                                                                                                                                                                                                                                                                                        The type of project being built.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        vpc: IVpc

                                                                                                                                                                                                                                                                                                                        VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                        Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                        Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        encryptionKey: Key

                                                                                                                                                                                                                                                                                                                        The encryption key use across

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                        Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                        The pipeline source prefix

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                        The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                        The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                        The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                        The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                        ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                        Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        projectType: ProjectType

                                                                                                                                                                                                                                                                                                                        The type of project being built.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        vpc: IVpc

                                                                                                                                                                                                                                                                                                                        VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                        Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                        Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        encryptionKey: Key

                                                                                                                                                                                                                                                                                                                        The encryption key use across

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                        Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                        diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 446a739..f46ee3d 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                        aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                          Interface PipelineResourcesProps

                                                                                                                                                                                                                                                                                                                          Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                          interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                              env?: Environment;
                                                                                                                                                                                                                                                                                                                              stackName?: string;
                                                                                                                                                                                                                                                                                                                              tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                              notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                              synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                              terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                              analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                              crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                              permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                              suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                              propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                              resource_prefix: string;
                                                                                                                                                                                                                                                                                                                              ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                              pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                              pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                              pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                              loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                          • StackProps
                                                                                                                                                                                                                                                                                                                            • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                          description? +
                                                                                                                                                                                                                                                                                                                          interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                              env?: Environment;
                                                                                                                                                                                                                                                                                                                              stackName?: string;
                                                                                                                                                                                                                                                                                                                              tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                              notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                              synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                              terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                              analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                              crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                              permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                              suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                              propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                              resource_prefix: string;
                                                                                                                                                                                                                                                                                                                              ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                              pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                              pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                              pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                              loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                          • StackProps
                                                                                                                                                                                                                                                                                                                            • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                          description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                                                                                          resource_prefix: string

                                                                                                                                                                                                                                                                                                                          The resource prefix

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                          ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                          The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                          pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                          The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                          pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                          The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                          pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                          The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                          loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                          Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                          The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                          The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                          The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                          The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                          Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                          From a93c0cc3387bdd26371c2afc6a0a82d1fc827041 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 30 Sep 2025 05:38:56 +0000 Subject: [PATCH 61/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@51f8f6fbadf646d02bd33a515c?= =?UTF-8?q?a47e614b1b861a=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 3ba192e..e90d676 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                          aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                            Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                                                                                            The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                                                                            See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                            • Stack
                                                                                                                                                                                                                                                                                                                              • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                            constructor +

                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                            • Stack
                                                                                                                                                                                                                                                                                                                              • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                            constructor

                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                            tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                            tags: TagManager

                                                                                                                                                                                                                                                                                                                            Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                            tags: TagManager

                                                                                                                                                                                                                                                                                                                            Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                            templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                            Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                            region: string

                                                                                                                                                                                                                                                                                                                            The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                            This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                            diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 3204a64..909f947 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                            aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                              Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                                                                                              The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                                                                                              For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                              • Stack
                                                                                                                                                                                                                                                                                                                                • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                              constructor +

                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                              • Stack
                                                                                                                                                                                                                                                                                                                                • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                              constructor

                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                              tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                              tags: TagManager

                                                                                                                                                                                                                                                                                                                              Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                              tags: TagManager

                                                                                                                                                                                                                                                                                                                              Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                              templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                              Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                              region: string

                                                                                                                                                                                                                                                                                                                              The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                              This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                              @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                                                                                              Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                                                              _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                                                              Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                                                              Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                                                              _notificationArns?: string[]

                                                                                                                                                                                                                                                                                                                              SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                                                              ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                              The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                              The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              node: Node

                                                                                                                                                                                                                                                                                                                              The tree node.

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                              The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              node: Node

                                                                                                                                                                                                                                                                                                                              The tree node.

                                                                                                                                                                                                                                                                                                                              Accessors

                                                                                                                                                                                                                                                                                                                              • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                                                                Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                                                                Returns boolean

                                                                                                                                                                                                                                                                                                                              • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                • value: boolean

                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                              • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                                                                Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                                                                Returns Stack[]

                                                                                                                                                                                                                                                                                                                              pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                              The pipeline source prefix

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                              Artifact bucket to use

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                              The ECR Repository to push to.

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              encryptionKey: Key

                                                                                                                                                                                                                                                                                                                              The encryption key use across

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                              diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 9e6d37a..b682a79 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                                                                                                Properties to allow customizing the build.

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                    description?: string;
                                                                                                                                                                                                                                                                                                                                    env?: Environment;
                                                                                                                                                                                                                                                                                                                                    stackName?: string;
                                                                                                                                                                                                                                                                                                                                    tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                    notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                    synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                    terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                    analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                    crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                    permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                    suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                    propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                    pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                    pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                    pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                    pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                    pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                    pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                    ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                    ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                    projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                    vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                    encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                    sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                                • StackProps
                                                                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                description? +
                                                                                                                                                                                                                                                                                                                                interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                    description?: string;
                                                                                                                                                                                                                                                                                                                                    env?: Environment;
                                                                                                                                                                                                                                                                                                                                    stackName?: string;
                                                                                                                                                                                                                                                                                                                                    tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                    notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                    synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                    terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                    analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                    crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                    permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                    suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                    propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                    pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                    pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                    pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                    pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                    pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                    pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                    ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                    ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                    projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                    vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                    encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                    sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                                • StackProps
                                                                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                                                                                                pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                                                                                The pipeline source bucket

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                The type of project being built.

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                vpc: IVpc

                                                                                                                                                                                                                                                                                                                                VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                The encryption key use across

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                The type of project being built.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                vpc: IVpc

                                                                                                                                                                                                                                                                                                                                VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                The encryption key use across

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index f46ee3d..8799fa7 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                  Interface PipelineResourcesProps

                                                                                                                                                                                                                                                                                                                                  Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                  interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                                                      env?: Environment;
                                                                                                                                                                                                                                                                                                                                      stackName?: string;
                                                                                                                                                                                                                                                                                                                                      tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                      notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                      terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                      analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                      propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                      resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                      ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                      pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                      pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                      pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                      loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                  • StackProps
                                                                                                                                                                                                                                                                                                                                    • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                  description? +
                                                                                                                                                                                                                                                                                                                                  interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                                                      env?: Environment;
                                                                                                                                                                                                                                                                                                                                      stackName?: string;
                                                                                                                                                                                                                                                                                                                                      tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                      notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                      terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                      analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                      propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                      resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                      ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                      pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                      pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                      pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                      loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                  • StackProps
                                                                                                                                                                                                                                                                                                                                    • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                  description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                                                                                                  resource_prefix: string

                                                                                                                                                                                                                                                                                                                                  The resource prefix

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                  ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                  The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                  pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                  The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                  pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                  The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                  pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                  The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                  loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                  Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                  The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                  The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                  The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                  The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                  Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                  From 64a9fde0569a1d60dc18535302b7a561f2035ecf Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 30 Sep 2025 05:39:20 +0000 Subject: [PATCH 62/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@ca82c908779ebc7b8c52dab3ce?= =?UTF-8?q?73d79446ba9899=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index e90d676..08f8b6d 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                    Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                                                                                                    The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                                                                                    See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                    • Stack
                                                                                                                                                                                                                                                                                                                                      • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                    constructor +

                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                    • Stack
                                                                                                                                                                                                                                                                                                                                      • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                    constructor

                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                    tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                    tags: TagManager

                                                                                                                                                                                                                                                                                                                                    Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                    tags: TagManager

                                                                                                                                                                                                                                                                                                                                    Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                    templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                    Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                    region: string

                                                                                                                                                                                                                                                                                                                                    The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                    This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                    diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 909f947..17ef93f 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                    aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                      Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                                                                                                      The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                                                                                                      For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                      • Stack
                                                                                                                                                                                                                                                                                                                                        • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                      constructor +

                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                      • Stack
                                                                                                                                                                                                                                                                                                                                        • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                      constructor

                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                      tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                      tags: TagManager

                                                                                                                                                                                                                                                                                                                                      Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                      tags: TagManager

                                                                                                                                                                                                                                                                                                                                      Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                      templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                      Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                      region: string

                                                                                                                                                                                                                                                                                                                                      The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                      This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                      @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                                                                                                      Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                                                                      _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                                                                      Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                                                                      Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                                                                      _notificationArns?: string[]

                                                                                                                                                                                                                                                                                                                                      SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                                                                      ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                      The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                      The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      node: Node

                                                                                                                                                                                                                                                                                                                                      The tree node.

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                      The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      node: Node

                                                                                                                                                                                                                                                                                                                                      The tree node.

                                                                                                                                                                                                                                                                                                                                      Accessors

                                                                                                                                                                                                                                                                                                                                      • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                                                                        Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                                      • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                        • value: boolean

                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                      • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                                                                        Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                                                                        Returns Stack[]

                                                                                                                                                                                                                                                                                                                                      pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                      The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                      Artifact bucket to use

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                      The ECR Repository to push to.

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                      The encryption key use across

                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                      diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index b682a79..b4b4251 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                      aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                        Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                                                                                                        Properties to allow customizing the build.

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                            description?: string;
                                                                                                                                                                                                                                                                                                                                            env?: Environment;
                                                                                                                                                                                                                                                                                                                                            stackName?: string;
                                                                                                                                                                                                                                                                                                                                            tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                            notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                            synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                            terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                            analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                            crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                            permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                            suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                            propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                            pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                            pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                            pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                            pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                            pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                            pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                            ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                            ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                            projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                            vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                            encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                            sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                                        • StackProps
                                                                                                                                                                                                                                                                                                                                          • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                        description? +
                                                                                                                                                                                                                                                                                                                                        interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                            description?: string;
                                                                                                                                                                                                                                                                                                                                            env?: Environment;
                                                                                                                                                                                                                                                                                                                                            stackName?: string;
                                                                                                                                                                                                                                                                                                                                            tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                            notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                            synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                            terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                            analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                            crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                            permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                            suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                            propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                            pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                            pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                            pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                            pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                            pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                            pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                            ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                            ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                            projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                            vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                            encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                            sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                                        • StackProps
                                                                                                                                                                                                                                                                                                                                          • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                        description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                                                                                                        pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                                                                                        The pipeline source bucket

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                        The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                        The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                        The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                        The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                        The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                        ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                        Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                        The type of project being built.

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        vpc: IVpc

                                                                                                                                                                                                                                                                                                                                        VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                        Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                        Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                        The encryption key use across

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                        Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                        The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                        The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                        The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                        The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                        The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                        ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                        Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                        The type of project being built.

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        vpc: IVpc

                                                                                                                                                                                                                                                                                                                                        VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                        Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                        Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                        The encryption key use across

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                        Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                        diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 8799fa7..9e1aa6a 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                        aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                          Interface PipelineResourcesProps

                                                                                                                                                                                                                                                                                                                                          Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                              env?: Environment;
                                                                                                                                                                                                                                                                                                                                              stackName?: string;
                                                                                                                                                                                                                                                                                                                                              tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                              notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                              synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                              terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                              analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                              crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                              permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                              suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                              propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                              resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                              ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                              pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                              pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                              pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                              loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                          • StackProps
                                                                                                                                                                                                                                                                                                                                            • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          description? +
                                                                                                                                                                                                                                                                                                                                          interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                              env?: Environment;
                                                                                                                                                                                                                                                                                                                                              stackName?: string;
                                                                                                                                                                                                                                                                                                                                              tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                              notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                              synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                              terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                              analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                              crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                              permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                              suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                              propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                              resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                              ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                              pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                              pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                              pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                              loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                          • StackProps
                                                                                                                                                                                                                                                                                                                                            • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                                                                                                          resource_prefix: string

                                                                                                                                                                                                                                                                                                                                          The resource prefix

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                          The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                          The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                          The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                          The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                          Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                          The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                          The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                          The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                          The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                          Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                          From 7228271b46e3de48bed08e19fe5ed1a62bdc6f0b Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 30 Sep 2025 05:39:22 +0000 Subject: [PATCH 63/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@9c0064d99de4a11747041f7d20?= =?UTF-8?q?c6d0ac77d15dfe=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 08f8b6d..3352a76 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                          aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                            Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                                                                                                            The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                                                                                            See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                            • Stack
                                                                                                                                                                                                                                                                                                                                              • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                            constructor +

                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                            • Stack
                                                                                                                                                                                                                                                                                                                                              • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                            constructor

                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                            tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                            tags: TagManager

                                                                                                                                                                                                                                                                                                                                            Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                            tags: TagManager

                                                                                                                                                                                                                                                                                                                                            Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                            templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                            Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                            region: string

                                                                                                                                                                                                                                                                                                                                            The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                            This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                            diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 17ef93f..8fc39bf 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                            aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                              Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                                                                                                              The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                                                                                                              For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                              • Stack
                                                                                                                                                                                                                                                                                                                                                • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                              constructor +

                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                              • Stack
                                                                                                                                                                                                                                                                                                                                                • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                              constructor

                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                              tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                              tags: TagManager

                                                                                                                                                                                                                                                                                                                                              Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                              tags: TagManager

                                                                                                                                                                                                                                                                                                                                              Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                              templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                              Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                              region: string

                                                                                                                                                                                                                                                                                                                                              The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                              This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                              @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                                                                                                              Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                                                                              _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                                                                              Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                                                                              Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                                                                              _notificationArns?: string[]

                                                                                                                                                                                                                                                                                                                                              SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                                                                              ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                              The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                              ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                              The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                              node: Node

                                                                                                                                                                                                                                                                                                                                              The tree node.

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                              The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              node: Node

                                                                                                                                                                                                                                                                                                                                              The tree node.

                                                                                                                                                                                                                                                                                                                                              Accessors

                                                                                                                                                                                                                                                                                                                                              • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                                                                                Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                                                                                Returns boolean

                                                                                                                                                                                                                                                                                                                                              • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                • value: boolean

                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                              • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                                                                                Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                                                                                Returns Stack[]

                                                                                                                                                                                                                                                                                                                                              pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                              The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                              Artifact bucket to use

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                              The ECR Repository to push to.

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                              The encryption key use across

                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                              diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index b4b4251..33968de 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                                                                                                                Properties to allow customizing the build.

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                    description?: string;
                                                                                                                                                                                                                                                                                                                                                    env?: Environment;
                                                                                                                                                                                                                                                                                                                                                    stackName?: string;
                                                                                                                                                                                                                                                                                                                                                    tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                    notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                    synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                    terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                    analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                    crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                    permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                    suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                    propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                    pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                    pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                    pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                    pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                    pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                    pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                    ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                    ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                    projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                    vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                    encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                    sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                                                • StackProps
                                                                                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                description? +
                                                                                                                                                                                                                                                                                                                                                interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                    description?: string;
                                                                                                                                                                                                                                                                                                                                                    env?: Environment;
                                                                                                                                                                                                                                                                                                                                                    stackName?: string;
                                                                                                                                                                                                                                                                                                                                                    tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                    notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                    synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                    terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                    analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                    crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                    permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                    suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                    propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                    pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                    pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                    pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                    pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                    pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                    pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                    ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                    ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                    projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                    vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                    buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                    environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                    encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                    sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                                                • StackProps
                                                                                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                                                                                                                pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                                                                                                The pipeline source bucket

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                The type of project being built.

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                The encryption key use across

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                The type of project being built.

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                The encryption key use across

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 9e1aa6a..d8aa655 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                  Interface PipelineResourcesProps

                                                                                                                                                                                                                                                                                                                                                  Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                  interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                                                                      env?: Environment;
                                                                                                                                                                                                                                                                                                                                                      stackName?: string;
                                                                                                                                                                                                                                                                                                                                                      tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                      notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                      terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                      analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                      propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                      resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                      ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                      pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                      pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                      loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                  • StackProps
                                                                                                                                                                                                                                                                                                                                                    • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                  description? +
                                                                                                                                                                                                                                                                                                                                                  interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                                                                      env?: Environment;
                                                                                                                                                                                                                                                                                                                                                      stackName?: string;
                                                                                                                                                                                                                                                                                                                                                      tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                      notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                      terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                      analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                      propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                      resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                      ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                      pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                      pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                      loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                  • StackProps
                                                                                                                                                                                                                                                                                                                                                    • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                  description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                                                                                                                  resource_prefix: string

                                                                                                                                                                                                                                                                                                                                                  The resource prefix

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                  ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                  The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                  The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                  pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                  The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                  pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                  The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                  loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                  Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                  The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                  The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                  The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                  The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                  Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                  From 535ac36636546e700f7a1be6f1401615cfb5b3f1 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 30 Sep 2025 05:39:32 +0000 Subject: [PATCH 64/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@7afce1d116bffa50372ee77096?= =?UTF-8?q?13a784850f18c3=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 3352a76..2784b8f 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                    Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                                                                                                                    The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                                                                                                    See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                    • Stack
                                                                                                                                                                                                                                                                                                                                                      • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                    constructor +

                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                    • Stack
                                                                                                                                                                                                                                                                                                                                                      • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                    constructor

                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                    tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                    tags: TagManager

                                                                                                                                                                                                                                                                                                                                                    Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                    tags: TagManager

                                                                                                                                                                                                                                                                                                                                                    Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                    templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                    Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                    region: string

                                                                                                                                                                                                                                                                                                                                                    The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                    This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                    diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 8fc39bf..cba46f6 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                    aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                      Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                                                                                                                      The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                                                                                                                      For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                                      • Stack
                                                                                                                                                                                                                                                                                                                                                        • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                      constructor +

                                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                                      • Stack
                                                                                                                                                                                                                                                                                                                                                        • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                      constructor

                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                      tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                      tags: TagManager

                                                                                                                                                                                                                                                                                                                                                      Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                      tags: TagManager

                                                                                                                                                                                                                                                                                                                                                      Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                      templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                      Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                      region: string

                                                                                                                                                                                                                                                                                                                                                      The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                      This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                      @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                                                                                                                      Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                                                                                      _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                                                                                      Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                                                                                      Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                                                                                      _notificationArns?: string[]

                                                                                                                                                                                                                                                                                                                                                      SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                                                                                      ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                      The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                      ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                      The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                      node: Node

                                                                                                                                                                                                                                                                                                                                                      The tree node.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                      The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      node: Node

                                                                                                                                                                                                                                                                                                                                                      The tree node.

                                                                                                                                                                                                                                                                                                                                                      Accessors

                                                                                                                                                                                                                                                                                                                                                      • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                                                                                        Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                                                      • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                        • value: boolean

                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                      • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                                                                                        Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                                                                                        Returns Stack[]

                                                                                                                                                                                                                                                                                                                                                      pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                      The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                      Artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                      The ECR Repository to push to.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                      The encryption key use across

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                      diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 33968de..69df271 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                      aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                        Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                                                                                                                        Properties to allow customizing the build.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                            description?: string;
                                                                                                                                                                                                                                                                                                                                                            env?: Environment;
                                                                                                                                                                                                                                                                                                                                                            stackName?: string;
                                                                                                                                                                                                                                                                                                                                                            tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                            notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                            synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                            terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                            analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                            crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                            permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                            suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                            propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                            pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                            pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                            pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                            pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                            pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                            pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                            ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                            ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                            projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                            vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                            encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                            sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                                                        • StackProps
                                                                                                                                                                                                                                                                                                                                                          • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        description? +
                                                                                                                                                                                                                                                                                                                                                        interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                            description?: string;
                                                                                                                                                                                                                                                                                                                                                            env?: Environment;
                                                                                                                                                                                                                                                                                                                                                            stackName?: string;
                                                                                                                                                                                                                                                                                                                                                            tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                            notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                            synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                            terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                            analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                            crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                            permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                            suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                            propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                            pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                            pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                            pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                            pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                            pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                            pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                            ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                            ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                            projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                            vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                            buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                            environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                            encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                            sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                                                        • StackProps
                                                                                                                                                                                                                                                                                                                                                          • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                                                                                                                        pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                                                                                                        The pipeline source bucket

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                        The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                        The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                        The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                        The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                        The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                        ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                        Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                        The type of project being built.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                        VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                        Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                        Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                        The encryption key use across

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                        Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                        The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                        The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                        The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                        The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                        The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                        ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                        Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                        The type of project being built.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                        VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                        Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                        Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                        The encryption key use across

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                        Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                        diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index d8aa655..93002e4 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                        aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                          Interface PipelineResourcesProps

                                                                                                                                                                                                                                                                                                                                                          Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                          interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                                              env?: Environment;
                                                                                                                                                                                                                                                                                                                                                              stackName?: string;
                                                                                                                                                                                                                                                                                                                                                              tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                              notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                              synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                              terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                              analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                              crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                              permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                              suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                              propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                              resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                              ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                              pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                              pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                              loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                                          • StackProps
                                                                                                                                                                                                                                                                                                                                                            • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                          description? +
                                                                                                                                                                                                                                                                                                                                                          interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                                              env?: Environment;
                                                                                                                                                                                                                                                                                                                                                              stackName?: string;
                                                                                                                                                                                                                                                                                                                                                              tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                              notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                              synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                              terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                              analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                              crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                              permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                              suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                              propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                              resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                              ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                              pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                              pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                              loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                                          • StackProps
                                                                                                                                                                                                                                                                                                                                                            • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                          description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                                                                                                                          resource_prefix: string

                                                                                                                                                                                                                                                                                                                                                          The resource prefix

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                          ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                          The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                          The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                          pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                          The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                          pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                          The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                          loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                          Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                          The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                          The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                          The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                          The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                          Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                          From aa3035a282618dd64214a5e4574f1b2685f37f16 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 6 Oct 2025 20:03:04 +0000 Subject: [PATCH 65/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@68fc1a8b397dbbc1356b23505c?= =?UTF-8?q?69d5350d181b07=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 14 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 14 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 32 +++++++++---------- interfaces/PipelineResourcesProps.html | 16 +++++----- 9 files changed, 64 insertions(+), 64 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 2784b8f..73c7cb1 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                          aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                            Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                                                                                                                            The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                                                                                                            See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                                            • Stack
                                                                                                                                                                                                                                                                                                                                                              • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                            constructor +

                                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                                            • Stack
                                                                                                                                                                                                                                                                                                                                                              • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                            constructor

                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                            tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                            tags: TagManager

                                                                                                                                                                                                                                                                                                                                                            Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                            tags: TagManager

                                                                                                                                                                                                                                                                                                                                                            Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                            templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                            Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                            region: string

                                                                                                                                                                                                                                                                                                                                                            The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                            This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                            diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index cba46f6..606fd6f 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                            aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                              Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                                                                                                                              The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                                                                                                                              For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                              • Stack
                                                                                                                                                                                                                                                                                                                                                                • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                              constructor +

                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                              • Stack
                                                                                                                                                                                                                                                                                                                                                                • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                              constructor

                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                              tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                              tags: TagManager

                                                                                                                                                                                                                                                                                                                                                              Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                              tags: TagManager

                                                                                                                                                                                                                                                                                                                                                              Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                              templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                              Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                              region: string

                                                                                                                                                                                                                                                                                                                                                              The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                              This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                              @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                                                                                                                              Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                                                                                              _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                                                                                              Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                                                                                              Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                                                                                              _notificationArns?: string[]

                                                                                                                                                                                                                                                                                                                                                              SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                                                                                              ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                              The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                              ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                              The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                              node: Node

                                                                                                                                                                                                                                                                                                                                                              The tree node.

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                              The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              node: Node

                                                                                                                                                                                                                                                                                                                                                              The tree node.

                                                                                                                                                                                                                                                                                                                                                              Accessors

                                                                                                                                                                                                                                                                                                                                                              • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                                                                                                Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                                                                                                Returns boolean

                                                                                                                                                                                                                                                                                                                                                              • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                • value: boolean

                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                              • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                                                                                                Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                                                                                                Returns Stack[]

                                                                                                                                                                                                                                                                                                                                                              ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                              Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                              VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                              Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                              The encryption key use across

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                              diff --git a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html index 75f10d8..2f412a9 100644 --- a/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineBaseImageProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineBaseImageProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                Interface EmbeddedLinuxCodePipelineBaseImageProps

                                                                                                                                                                                                                                                                                                                                                                Select options for the BuildImageCodePipelineStack.

                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                interface EmbeddedLinuxCodePipelineBaseImageProps {
                                                                                                                                                                                                                                                                                                                                                                    description?: string;
                                                                                                                                                                                                                                                                                                                                                                    env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                    stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                    tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                    notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                    synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                    terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                    analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                    crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                    permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                    suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                    propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                    pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                    pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                    pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                    ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                    encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                                                                • StackProps
                                                                                                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodePipelineBaseImageProps
                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                description? +
                                                                                                                                                                                                                                                                                                                                                                interface EmbeddedLinuxCodePipelineBaseImageProps {
                                                                                                                                                                                                                                                                                                                                                                    description?: string;
                                                                                                                                                                                                                                                                                                                                                                    env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                    stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                    tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                    notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                    synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                    terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                    analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                    crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                    permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                    suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                    propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                    pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                    pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                    pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                    ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                    encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                                                                • StackProps
                                                                                                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodePipelineBaseImageProps
                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                description? env? stackName? tags? @@ -59,7 +59,7 @@
                                                                                                                                                                                                                                                                                                                                                                notificationArns?: string[]

                                                                                                                                                                                                                                                                                                                                                                SNS Topic ARNs that will receive stack events.

                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                - no notfication arns.
+
                                                                                                                                                                                                                                                                                                                                                                - no notification arns.
                                                                                                                                                                                                                                                                                                                                                                synthesizer?: IStackSynthesizer

                                                                                                                                                                                                                                                                                                                                                                Synthesis method to use while deploying this stack

                                                                                                                                                                                                                                                                                                                                                                @@ -106,8 +106,8 @@
                                                                                                                                                                                                                                                                                                                                                                pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                                                                                                                The pipeline source bucket

                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                Artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                The ECR Repository to push to.

                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                Artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                The ECR Repository to push to.

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 69df271..55750cc 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                  Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                                                                                                                                  Properties to allow customizing the build.

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                                                                                      env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                      stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                      tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                      notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                      terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                      analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                      propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                      pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                      pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                      ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                      ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                      projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                      vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                      buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                      environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                      encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                      sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                  • StackProps
                                                                                                                                                                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  description? +
                                                                                                                                                                                                                                                                                                                                                                  interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                                                                                      env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                      stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                      tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                      notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                      terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                      analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                      propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                      pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                      pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                      ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                      ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                      projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                      vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                      buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                      environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                      encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                      sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                  • StackProps
                                                                                                                                                                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  description? env? stackName? tags? @@ -68,7 +68,7 @@
                                                                                                                                                                                                                                                                                                                                                                  notificationArns?: string[]

                                                                                                                                                                                                                                                                                                                                                                  SNS Topic ARNs that will receive stack events.

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - no notfication arns.
+
                                                                                                                                                                                                                                                                                                                                                                  - no notification arns.
                                                                                                                                                                                                                                                                                                                                                                  synthesizer?: IStackSynthesizer

                                                                                                                                                                                                                                                                                                                                                                  Synthesis method to use while deploying this stack

                                                                                                                                                                                                                                                                                                                                                                  @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                                                                                                                                  pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                                                                                                                  The pipeline source bucket

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                  The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                  ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                  Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                  The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                  VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                  Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                  Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                  The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                  Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                  The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                  ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                  Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                  The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                  VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                  Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                  Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                  The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                  Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                  diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 93002e4..41b8fed 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                    Interface PipelineResourcesProps

                                                                                                                                                                                                                                                                                                                                                                    Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                        resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                        pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                        pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                        loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                                                                                                                                                                                      • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                    description? +
                                                                                                                                                                                                                                                                                                                                                                    interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                        resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                        pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                        pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                        loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                                                                                                                                                                                      • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                    description? env? stackName? tags? @@ -60,7 +60,7 @@
                                                                                                                                                                                                                                                                                                                                                                    notificationArns?: string[]

                                                                                                                                                                                                                                                                                                                                                                    SNS Topic ARNs that will receive stack events.

                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    - no notfication arns.
+
                                                                                                                                                                                                                                                                                                                                                                    - no notification arns.
                                                                                                                                                                                                                                                                                                                                                                    synthesizer?: IStackSynthesizer

                                                                                                                                                                                                                                                                                                                                                                    Synthesis method to use while deploying this stack

                                                                                                                                                                                                                                                                                                                                                                    @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                                                                                                                                    resource_prefix: string

                                                                                                                                                                                                                                                                                                                                                                    The resource prefix

                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                    The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                    The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                    The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                    The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                    Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                    The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                    The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                    The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                    The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                    Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                    From b031b3e769a89e371036ec4e0709794e74b2bf62 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 6 Oct 2025 20:03:30 +0000 Subject: [PATCH 66/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@f7116ab08737e294c801a730df?= =?UTF-8?q?9b010bd6107293=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 73c7cb1..25f4205 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                    aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                      Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                                                                                                                                      The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                                                                                                                      See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                                                      • Stack
                                                                                                                                                                                                                                                                                                                                                                        • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                      constructor +

                                                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                                                      • Stack
                                                                                                                                                                                                                                                                                                                                                                        • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                      constructor

                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                      tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                      tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                      Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                      tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                      Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                      templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                                      Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                                      region: string

                                                                                                                                                                                                                                                                                                                                                                      The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                                      This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                                      diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 606fd6f..5588ff5 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                      aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                        Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                                                                                                                                        The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                                                                                                                                        For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                                                                        • Stack
                                                                                                                                                                                                                                                                                                                                                                          • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                        constructor +

                                                                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                                                                        • Stack
                                                                                                                                                                                                                                                                                                                                                                          • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                        tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                        templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                                        Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                                        region: string

                                                                                                                                                                                                                                                                                                                                                                        The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                                        This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                                        @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                                                                                                                                        Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                                                                                                        _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                                                                                                        Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                                                                                                        Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                                                                                                        _notificationArns?: string[]

                                                                                                                                                                                                                                                                                                                                                                        SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                                                                                                        ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                        The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                        The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        node: Node

                                                                                                                                                                                                                                                                                                                                                                        The tree node.

                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                        The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        node: Node

                                                                                                                                                                                                                                                                                                                                                                        The tree node.

                                                                                                                                                                                                                                                                                                                                                                        Accessors

                                                                                                                                                                                                                                                                                                                                                                        • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                                                                                                          Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                                                                                                        • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                          • value: boolean

                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                        • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                                                                                                          Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                                                                                                          Returns Stack[]

                                                                                                                                                                                                                                                                                                                                                                        pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                        The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                        Artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                        The ECR Repository to push to.

                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                        The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                        diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 55750cc..e25d295 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                        aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                          Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                                                                                                                                          Properties to allow customizing the build.

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                                                              env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                              stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                              tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                              notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                              synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                              terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                              analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                              crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                              permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                              suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                              propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                              pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                              pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                              pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                              pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                              ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                              ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                              projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                              vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                              buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                              environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                              encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                              sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                                                          • StackProps
                                                                                                                                                                                                                                                                                                                                                                            • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                          description? +
                                                                                                                                                                                                                                                                                                                                                                          interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                                                              env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                              stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                              tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                              notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                              synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                              terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                              analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                              crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                              permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                              suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                              propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                              pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                              pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                              pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                              pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                              ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                              ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                              projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                              vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                              buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                              environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                              encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                              sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                                                          • StackProps
                                                                                                                                                                                                                                                                                                                                                                            • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                          description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                                                                                                                                          pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                                                                                                                          The pipeline source bucket

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                          The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                          The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                          The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                          The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                          The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                          ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                          Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                          The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                          VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                          Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                          Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                          The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                          Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                          The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                          The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                          The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                          The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                          The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                          ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                          Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                          The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                          VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                          Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                          Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                          The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                          Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                          diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 41b8fed..d7a8cb1 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                          aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                            Interface PipelineResourcesProps

                                                                                                                                                                                                                                                                                                                                                                            Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                                pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                                                                                                                                                                                              • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                            description? +
                                                                                                                                                                                                                                                                                                                                                                            interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                                pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                                                                                                                                                                                              • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                            description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                                                                                                                                            resource_prefix: string

                                                                                                                                                                                                                                                                                                                                                                            The resource prefix

                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                            The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                            The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                            The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                            The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                            Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                            The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                            The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                            The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                            The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                            Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                            From 47579de2f4f444e6708121f69c05bf514f41178e Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 13 Oct 2025 17:08:21 +0000 Subject: [PATCH 67/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@41fde206c2293df1ec7a1f8224?= =?UTF-8?q?c003a16fea4eb4=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 25f4205..e129a74 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                            aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                              Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                                                                                                                                              The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                                                                                                                              See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                                              • Stack
                                                                                                                                                                                                                                                                                                                                                                                • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                              constructor +

                                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                                              • Stack
                                                                                                                                                                                                                                                                                                                                                                                • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                              constructor

                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                              tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                              tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                              Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                              tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                              Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                              templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                                              Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                                              region: string

                                                                                                                                                                                                                                                                                                                                                                              The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                                              This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                                              diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 5588ff5..154d240 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                                                                                                                                                The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                                                                                                                                                For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                • Stack
                                                                                                                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                constructor +

                                                                                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                • Stack
                                                                                                                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                constructor

                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                                                Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                                                region: string

                                                                                                                                                                                                                                                                                                                                                                                The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                                                This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                                                @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                                                                                                                                                Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                                                                                                                _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                                                                                                                Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                                                                                                                Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                                                                                                                _notificationArns?: string[]

                                                                                                                                                                                                                                                                                                                                                                                SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                                                                                                                ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                node: Node

                                                                                                                                                                                                                                                                                                                                                                                The tree node.

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                node: Node

                                                                                                                                                                                                                                                                                                                                                                                The tree node.

                                                                                                                                                                                                                                                                                                                                                                                Accessors

                                                                                                                                                                                                                                                                                                                                                                                • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                                                                                                                  Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                  • value: boolean

                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                                                                                                                  Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                                                                                                                  Returns Stack[]

                                                                                                                                                                                                                                                                                                                                                                                pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                Artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                The ECR Repository to push to.

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index e25d295..1a38eef 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                  Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                                                                                                                                                  Properties to allow customizing the build.

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                                                                                                      env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                      stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                      tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                      notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                      terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                      analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                      propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                      pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                                      pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                      ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                                      ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                                      projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                                      vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                                      buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                                      environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                                      encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                                      sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                  • StackProps
                                                                                                                                                                                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                  description? +
                                                                                                                                                                                                                                                                                                                                                                                  interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                                                                                                      env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                      stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                      tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                      notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                      terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                      analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                      propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                      pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                                      pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                      ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                                      ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                                      projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                                      vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                                      buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                                      environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                                      encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                                      sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                  • StackProps
                                                                                                                                                                                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                  description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                                                                                                                                                  pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                                                                                                                                  The pipeline source bucket

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                  The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                  ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                  Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                                  The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                                  VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                                  Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                                  Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                  The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                                  Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                  The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                  ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                  Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                                  The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                                  VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                                  Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                                  Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                  The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                                  Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index d7a8cb1..ff4d384 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                    Interface PipelineResourcesProps

                                                                                                                                                                                                                                                                                                                                                                                    Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                        resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                        pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                        pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                        loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                                                                                                                                                                                                      • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                    description? +
                                                                                                                                                                                                                                                                                                                                                                                    interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                        resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                        pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                        pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                        loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                                                                                                                                                                                                      • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                    description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                                                                                                                                                    resource_prefix: string

                                                                                                                                                                                                                                                                                                                                                                                    The resource prefix

                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                                    The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                    The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                    The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                    The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                    Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                                    The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                    The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                    The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                    The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                    Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                    From cec6fe7f754791af07dd316f5e7e78340077527c Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 13 Oct 2025 17:08:30 +0000 Subject: [PATCH 68/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@2f82d8b59c7501a273ce3ded7a?= =?UTF-8?q?c1792b4c819c63=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index e129a74..df36599 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                    aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                      Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                                                                                                                                                      The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                                                                                                                                      See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                      • Stack
                                                                                                                                                                                                                                                                                                                                                                                        • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                      constructor +

                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                      • Stack
                                                                                                                                                                                                                                                                                                                                                                                        • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                      constructor

                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                      tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                      tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                      Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                      tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                      Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                      templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                                                      Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                                                      region: string

                                                                                                                                                                                                                                                                                                                                                                                      The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                                                      This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 154d240..ee194d7 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                      aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                        Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                                                                                                                                                        The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                                                                                                                                                        For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                        • Stack
                                                                                                                                                                                                                                                                                                                                                                                          • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                        constructor +

                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                        • Stack
                                                                                                                                                                                                                                                                                                                                                                                          • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                        tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                        templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                                                        Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                                                        region: string

                                                                                                                                                                                                                                                                                                                                                                                        The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                                                        This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                                                        @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                                                                                                                                                        Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                                                                                                                        _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                                                                                                                        Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                                                                                                                        Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                                                                                                                        _notificationArns?: string[]

                                                                                                                                                                                                                                                                                                                                                                                        SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                                                                                                                        ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                        The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                        The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                        node: Node

                                                                                                                                                                                                                                                                                                                                                                                        The tree node.

                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                        The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        node: Node

                                                                                                                                                                                                                                                                                                                                                                                        The tree node.

                                                                                                                                                                                                                                                                                                                                                                                        Accessors

                                                                                                                                                                                                                                                                                                                                                                                        • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                                                                                                                          Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                        • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                          • value: boolean

                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                        • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                                                                                                                          Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                                                                                                                          Returns Stack[]

                                                                                                                                                                                                                                                                                                                                                                                        pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                        The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                        Artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                        The ECR Repository to push to.

                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                        The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 1a38eef..1ae54c8 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                        aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                          Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                                                                                                                                                          Properties to allow customizing the build.

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                                                                              env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                              stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                              tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                              notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                              synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                              terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                              analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                              crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                              permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                              suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                              propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                              pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                                              pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                              pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                              pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                              ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                                              ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                                              projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                                              vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                                              buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                                              environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                                              encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                                              sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                          • StackProps
                                                                                                                                                                                                                                                                                                                                                                                            • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                          description? +
                                                                                                                                                                                                                                                                                                                                                                                          interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                                                                              env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                              stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                              tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                              notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                              synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                              terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                              analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                              crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                              permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                              suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                              propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                              pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                                              pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                              pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                              pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                              ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                                              ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                                              projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                                              vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                                              buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                                              environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                                              encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                                              sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                          • StackProps
                                                                                                                                                                                                                                                                                                                                                                                            • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                          description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                                                                                                                                                          pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                                                                                                                                          The pipeline source bucket

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                          The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                          The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                          The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                          The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                          The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                          ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                          Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                                          The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                                          VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                                          Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                                          Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                          The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                                          Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                          The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                          The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                          The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                          The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                          The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                          ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                          Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                                          The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                                          VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                                          Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                                          Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                          The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                                          Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index ff4d384..5039a27 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                          aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                            Interface PipelineResourcesProps

                                                                                                                                                                                                                                                                                                                                                                                            Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                                ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                                                                                                                                                                                                              • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                            description? +
                                                                                                                                                                                                                                                                                                                                                                                            interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                                ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                                                                                                                                                                                                              • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                            description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                                                                                                                                                            resource_prefix: string

                                                                                                                                                                                                                                                                                                                                                                                            The resource prefix

                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                                            The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                            The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                            The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                            The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                            Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                                            The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                            The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                            The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                            The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                            Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                            From 24e5b3bc493a7a39138be66456baa2b464eb77df Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 13 Oct 2025 17:17:26 +0000 Subject: [PATCH 69/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@fe2d57c988c4860cea954e1ee6?= =?UTF-8?q?5c97d3b7231b47=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index df36599..2c4304c 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                            aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                              Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                                                                                                                                                              The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                                                                                                                                              See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                              • Stack
                                                                                                                                                                                                                                                                                                                                                                                                • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                              constructor +

                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                              • Stack
                                                                                                                                                                                                                                                                                                                                                                                                • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                              constructor

                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                              tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                              tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                              Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                              tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                              Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                              templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                                                              Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                                                              region: string

                                                                                                                                                                                                                                                                                                                                                                                              The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                                                              This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index ee194d7..7e3acfd 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                                                                                                                                                                The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                                                                                                                                                                For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                • Stack
                                                                                                                                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                constructor +

                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                • Stack
                                                                                                                                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                constructor

                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                                                                Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                                                                region: string

                                                                                                                                                                                                                                                                                                                                                                                                The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                                                                This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                                                                @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                                                                                                                                                                Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                                                                                                                                _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                                                                                                                                Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                                                                                                                                Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                                                                                                                                _notificationArns?: string[]

                                                                                                                                                                                                                                                                                                                                                                                                SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                                                                                                                                ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                node: Node

                                                                                                                                                                                                                                                                                                                                                                                                The tree node.

                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                node: Node

                                                                                                                                                                                                                                                                                                                                                                                                The tree node.

                                                                                                                                                                                                                                                                                                                                                                                                Accessors

                                                                                                                                                                                                                                                                                                                                                                                                • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                                                                                                                                  Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • value: boolean

                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                                                                                                                                  Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                                                                                                                                  Returns Stack[]

                                                                                                                                                                                                                                                                                                                                                                                                pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                Artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                The ECR Repository to push to.

                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                                The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 1ae54c8..bdb8165 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                  Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                                                                                                                                                                  Properties to allow customizing the build.

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                      stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                      notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                      terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                      pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                                                      pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                                                      ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                                                      projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                                                      vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                                                      buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                                                      environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                                                      encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                                                      sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  description? +
                                                                                                                                                                                                                                                                                                                                                                                                  interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                      stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                      notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                      terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                      pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                                                      pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                                                      ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                                                      projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                                                      vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                                                      buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                                                      environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                                                      encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                                                      sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                                                                                                                                                                  pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline source bucket

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                  ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                  Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                                                  The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                                                  VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                                                  Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                                                  Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                                  The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                                                  Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                  ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                  Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                                                  The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                                                  VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                                                  Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                                                  Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                                  The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                                                  Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 5039a27..1acac49 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                    Interface PipelineResourcesProps

                                                                                                                                                                                                                                                                                                                                                                                                    Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                        resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                        pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                        pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                        loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                      • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                    description? +
                                                                                                                                                                                                                                                                                                                                                                                                    interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                        resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                        pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                        pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                        loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                      • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                    description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                                                                                                                                                                    resource_prefix: string

                                                                                                                                                                                                                                                                                                                                                                                                    The resource prefix

                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                                                    The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                    The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                    The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                    The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                    Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                                                    The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                    The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                    The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                    The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                    Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                    From 69a457d2cff98d0f0d461947d9a9bbdc76f471a8 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 20 Oct 2025 18:21:19 +0000 Subject: [PATCH 70/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@c8574ebd4bc7ddca4005c69909?= =?UTF-8?q?5e69ad294dd983=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 2c4304c..b0d0edf 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                    aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                      Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                                                                                                                                                                      The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                                                                                                                                                      See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                      • Stack
                                                                                                                                                                                                                                                                                                                                                                                                        • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                      constructor +

                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                      • Stack
                                                                                                                                                                                                                                                                                                                                                                                                        • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                      constructor

                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                      tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                      tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                      Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                      tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                      Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                      templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                                                                      Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                                                                      region: string

                                                                                                                                                                                                                                                                                                                                                                                                      The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                                                                      This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 7e3acfd..602aff8 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                      aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                        Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                                                                                                                                                                        The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                                                                                                                                                                        For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                        • Stack
                                                                                                                                                                                                                                                                                                                                                                                                          • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                        constructor +

                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                        • Stack
                                                                                                                                                                                                                                                                                                                                                                                                          • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                        tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                        templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                                                                        Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                                                                        region: string

                                                                                                                                                                                                                                                                                                                                                                                                        The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                                                                        This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                                                                        @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                                                                                                                                                                        Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                                                                                                                                        _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                                                                                                                                        Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                                                                                                                                        Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                                                                                                                                        _notificationArns?: string[]

                                                                                                                                                                                                                                                                                                                                                                                                        SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                                                                                                                                        ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                        The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                        The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        node: Node

                                                                                                                                                                                                                                                                                                                                                                                                        The tree node.

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                        The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        node: Node

                                                                                                                                                                                                                                                                                                                                                                                                        The tree node.

                                                                                                                                                                                                                                                                                                                                                                                                        Accessors

                                                                                                                                                                                                                                                                                                                                                                                                        • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                                                                                                                                          Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                        • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                          • value: boolean

                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                        • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                                                                                                                                          Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                                                                                                                                          Returns Stack[]

                                                                                                                                                                                                                                                                                                                                                                                                        pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                        The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                        Artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                        The ECR Repository to push to.

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                                        The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index bdb8165..d2c8322 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                        aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                          Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                                                                                                                                                                          Properties to allow customizing the build.

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                              env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                              stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                              tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                              notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                              synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                              terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                              analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                              crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                              permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                              suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                              propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                              pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                                                              pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                              pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                              pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                              ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                                                              ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                                                              projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                                                              vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                                                              buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                                                              environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                                                              encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                                                              sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                          • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                            • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                          description? +
                                                                                                                                                                                                                                                                                                                                                                                                          interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                              env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                              stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                              tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                              notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                              synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                              terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                              analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                              crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                              permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                              suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                              propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                              pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                                                              pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                              pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                              pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                              ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                                                              ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                                                              projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                                                              vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                                                              buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                                                              environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                                                              encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                                                              sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                          • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                            • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                          description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                                                                                                                                                                          pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline source bucket

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                          ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                          Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                                                          The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                                                          VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                                                          Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                                                          Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                                          The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                                                          Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                          ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                          Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                                                          The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                                                          VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                                                          Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                                                          Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                                          The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                                                          Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 1acac49..1479350 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                          aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                            Interface PipelineResourcesProps

                                                                                                                                                                                                                                                                                                                                                                                                            Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                                                ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                              • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                            description? +
                                                                                                                                                                                                                                                                                                                                                                                                            interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                                                ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                              • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                            description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                                                                                                                                                                            resource_prefix: string

                                                                                                                                                                                                                                                                                                                                                                                                            The resource prefix

                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                                                            The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                            The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                            The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                            The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                            Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                                                            The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                            The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                            The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                            The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                            Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                            From f55c18f4160396f002bf8dbc9bafecd0c9ea74c9 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 20 Oct 2025 18:41:01 +0000 Subject: [PATCH 71/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@220715617bf25dff47be08871a?= =?UTF-8?q?84b8bc73f37170=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index b0d0edf..ccb0acf 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                            aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                              Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                                                                                                                                                                              The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                                                                                                                                                              See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                              • Stack
                                                                                                                                                                                                                                                                                                                                                                                                                • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                              constructor +

                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                              • Stack
                                                                                                                                                                                                                                                                                                                                                                                                                • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                              constructor

                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                              tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                              tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                              Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                              tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                              Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                              templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                                                                              Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                                                                              region: string

                                                                                                                                                                                                                                                                                                                                                                                                              The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                                                                              This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 602aff8..2574b39 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                                                                                                                                                                                The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                                                                                                                                                                                For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                • Stack
                                                                                                                                                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                • Stack
                                                                                                                                                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                constructor

                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                                templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                                                                                Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                                                                                region: string

                                                                                                                                                                                                                                                                                                                                                                                                                The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                                                                                This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                                                                                @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                                                                                                                                                                                Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                                                                                                                                                _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                                                                                                                                                Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                                                                                                                                                _notificationArns?: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                                                                                                                                                ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                                The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                                The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                node: Node

                                                                                                                                                                                                                                                                                                                                                                                                                The tree node.

                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                                The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                node: Node

                                                                                                                                                                                                                                                                                                                                                                                                                The tree node.

                                                                                                                                                                                                                                                                                                                                                                                                                Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                                                                                                                                                  Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                  • value: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                                                                                                                                                  Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Stack[]

                                                                                                                                                                                                                                                                                                                                                                                                                pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                Artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                                The ECR Repository to push to.

                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                                                The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index d2c8322..35331dd 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                  Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties to allow customizing the build.

                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                  interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                      env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                      stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                      tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                      notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                      terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                      analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                      propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                      ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                                                                      ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                                                                      projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                                                                      vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                                                                      buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                                                                      environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                                                                      encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                                                                      sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                  • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                  description? +
                                                                                                                                                                                                                                                                                                                                                                                                                  interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                      env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                      stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                      tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                      notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                      terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                      analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                      propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                      ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                                                                      ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                                                                      projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                                                                      vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                                                                      buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                                                                      environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                                                                      encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                                                                      sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                  • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                  description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline source bucket

                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                                  ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                                  Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                  projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                                                                  The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                  vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                                                                  VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                  buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                                                                  Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                  environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                                                                  Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                  encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                                                  The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                  sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                                                                  Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                                  ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                                  Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                                                                  The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                                                                  VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                                                                  Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                                                                  Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                                                  The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                                                                  Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index 1479350..d1ac6c9 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                    Interface PipelineResourcesProps

                                                                                                                                                                                                                                                                                                                                                                                                                    Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                        resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                        loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                                      • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                    description? +
                                                                                                                                                                                                                                                                                                                                                                                                                    interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                        resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                        loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                                      • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                    description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                                                                                                                                                                                    resource_prefix: string

                                                                                                                                                                                                                                                                                                                                                                                                                    The resource prefix

                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                    The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                    The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                    The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                    The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                    Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                    The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                    The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                    The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                    The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                    Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                    From 44de68f96d8dc8e44c0a56bae4409d66c772c407 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Mon, 27 Oct 2025 18:04:05 +0000 Subject: [PATCH 72/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@dd3c8e4c960b1e8f16c100960c?= =?UTF-8?q?7c14068e9ac246=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index ccb0acf..44080dc 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                    aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                      Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                                                                                                                                                                                      The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                                                                                                                                                                      See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                      • Stack
                                                                                                                                                                                                                                                                                                                                                                                                                        • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                      constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                      • Stack
                                                                                                                                                                                                                                                                                                                                                                                                                        • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                      constructor

                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                      tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                      tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                                      Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                      tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                                      Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                                      templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                                                                                      Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                                                                                      region: string

                                                                                                                                                                                                                                                                                                                                                                                                                      The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                                                                                      This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 2574b39..41baa80 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                      aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                        Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                                                                                                                                                                                        The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                                                                                                                                                                                        For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                        • Stack
                                                                                                                                                                                                                                                                                                                                                                                                                          • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                        constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                        • Stack
                                                                                                                                                                                                                                                                                                                                                                                                                          • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                        tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                                        templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                                                                                        Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                                                                                        region: string

                                                                                                                                                                                                                                                                                                                                                                                                                        The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                                                                                        This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                                                                                                                                                                                        Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                                                                                                                                                        _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                        Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                                                                                                                                                        Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                                                                                                                                                        _notificationArns?: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                        SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                                                                                                                                                        ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                                        The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                                        The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        node: Node

                                                                                                                                                                                                                                                                                                                                                                                                                        The tree node.

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                                        The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        node: Node

                                                                                                                                                                                                                                                                                                                                                                                                                        The tree node.

                                                                                                                                                                                                                                                                                                                                                                                                                        Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                        • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                                                                                                                                                          Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                        • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                          • value: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                        • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                                                                                                                                                          Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Stack[]

                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                        The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                        Artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                                        The ECR Repository to push to.

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                                                        The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 35331dd..f2a05e5 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                        aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                          Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                                                                                                                                                                                          Properties to allow customizing the build.

                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                              env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                              stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                              tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                              notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                              synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                              terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                              analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                              crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                              permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                              suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                              propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                              ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                                                                              ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                                                                              projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                                                                              vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                                                                              buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                                                                              environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                                                                              encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                                                                              sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                          • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                                            • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                          description? +
                                                                                                                                                                                                                                                                                                                                                                                                                          interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                              env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                              stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                              tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                              notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                              synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                              terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                              analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                              crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                              permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                              suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                              propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                              ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                                                                              ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                                                                              projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                                                                              vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                                                                              buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                                                                              environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                                                                              encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                                                                              sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                          • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                                            • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                          description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline source bucket

                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                                          ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                                          Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                                                                          The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                                                                          VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                                                                          Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                                                                          Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                                                          The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                                                                          Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                                          ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                                          Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                                                                          The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                                                                          VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                                                                          Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                                                                          Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                                                          The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                                                                          Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index d1ac6c9..dd7054e 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                          aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                            Interface PipelineResourcesProps

                                                                                                                                                                                                                                                                                                                                                                                                                            Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                            interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                                resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                                              • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                            description? +
                                                                                                                                                                                                                                                                                                                                                                                                                            interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                                resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                                              • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                            description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                                                                                                                                                                                            resource_prefix: string

                                                                                                                                                                                                                                                                                                                                                                                                                            The resource prefix

                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                            ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                            The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                            pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                            The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                            pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                            The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                            pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                            The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                            loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                            Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                            The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                            The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                            The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                            The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                            Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                            From e3c7581405d0863b9686f73c0a490aacd340cabd Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 18 Nov 2025 09:35:48 +0000 Subject: [PATCH 73/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@6043ecb042cb1b825ef64534b8?= =?UTF-8?q?d09499a6cef483=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 44080dc..53ba664 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                            aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                              Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                                                                                                                                                                                              The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                                                                                                                                                                              See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                              • Stack
                                                                                                                                                                                                                                                                                                                                                                                                                                • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                              constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                              • Stack
                                                                                                                                                                                                                                                                                                                                                                                                                                • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                              constructor

                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                              tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                              tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                                              Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                              tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                                              Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                                              templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                                                                                              Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                                                                                              region: string

                                                                                                                                                                                                                                                                                                                                                                                                                              The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                                                                                              This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 41baa80..9932df2 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                                                                                                                                                                                                The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                                                                                                                                                                                                For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                • Stack
                                                                                                                                                                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                • Stack
                                                                                                                                                                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                                                templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                                                                                                region: string

                                                                                                                                                                                                                                                                                                                                                                                                                                The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                                                                                                This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                                                                                                                                                                _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                                                                                                                                                                Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                                                                                                                                                                _notificationArns?: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                                                                                                                                                                ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                                                The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                                                The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                node: Node

                                                                                                                                                                                                                                                                                                                                                                                                                                The tree node.

                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                                                The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                node: Node

                                                                                                                                                                                                                                                                                                                                                                                                                                The tree node.

                                                                                                                                                                                                                                                                                                                                                                                                                                Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                                • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                  • value: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                                                                                                                                                                  Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Stack[]

                                                                                                                                                                                                                                                                                                                                                                                                                                pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                Artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                                                The ECR Repository to push to.

                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                                                                The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index f2a05e5..36783eb 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties to allow customizing the build.

                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                      env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                                      stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                      tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                      notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                                      terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                      analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                      propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                      ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                                                                                      ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                      projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                                                                                      vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                                                                                      buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                                                                                      environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                                                                                      encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                                                                                      sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                  • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                  description? +
                                                                                                                                                                                                                                                                                                                                                                                                                                  interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                      env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                                      stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                      tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                      notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                                      terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                      analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                      propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                      ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                                                                                      ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                      projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                                                                                      vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                                                                                      buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                                                                                      environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                                                                                      encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                                                                                      sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                  • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                  description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline source bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                                                  ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                                                  Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                                                                                  The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                                                                                  VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                                                                                  Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                                                                                  Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                                                                  The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                  Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                                                  ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                                                  Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                                                                                  The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                                                                                  VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                                                                                  Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                                                                                  Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                                                                  The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                  Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index dd7054e..ff00172 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface PipelineResourcesProps

                                                                                                                                                                                                                                                                                                                                                                                                                                    Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                                        resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                                                      • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                    description? +
                                                                                                                                                                                                                                                                                                                                                                                                                                    interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                                        resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                                                      • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                    description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                    resource_prefix: string

                                                                                                                                                                                                                                                                                                                                                                                                                                    The resource prefix

                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                    The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                    The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                    The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                    The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                    Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                    The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                    The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                    The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                    The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                    Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                    From 75dc9d48ea78b7723be14d80a5cfc61f8edea033 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 18 Nov 2025 09:36:10 +0000 Subject: [PATCH 74/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@8d72af141092ea02e357a27791?= =?UTF-8?q?b42d99d221d2a0=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index 53ba664..bc4e67a 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                                    aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                      Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                                                                                                                                                                                                      The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                                                                                                                                                                                      See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                      • Stack
                                                                                                                                                                                                                                                                                                                                                                                                                                        • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                      constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                      • Stack
                                                                                                                                                                                                                                                                                                                                                                                                                                        • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                      constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                      tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                      tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                                                      Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                      tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                                                      Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                                                      templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                      Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                                                                                                      region: string

                                                                                                                                                                                                                                                                                                                                                                                                                                      The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                                                                                                      This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 9932df2..9fa2bd5 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                                      aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                        Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                                                                                                                                                                                                        The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                                                                                                                                                                                                        For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                        • Stack
                                                                                                                                                                                                                                                                                                                                                                                                                                          • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                        • Stack
                                                                                                                                                                                                                                                                                                                                                                                                                                          • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                        tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                        tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                                                        Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                                                        templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                        Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                                                                                                        region: string

                                                                                                                                                                                                                                                                                                                                                                                                                                        The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                                                                                                        This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                        Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                                                                                                                                                                        _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                        Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                                                                                                                                                                        _notificationArns?: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                        SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                                                                                                                                                                        ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                                                        The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                                                        The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                        node: Node

                                                                                                                                                                                                                                                                                                                                                                                                                                        The tree node.

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                                                        The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        node: Node

                                                                                                                                                                                                                                                                                                                                                                                                                                        The tree node.

                                                                                                                                                                                                                                                                                                                                                                                                                                        Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                                        • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                          Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                        • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                          • value: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                        • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                                                                                                                                                                          Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Stack[]

                                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                        The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                        Artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                                                        The ECR Repository to push to.

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                                                                        The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index 36783eb..a6a290a 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                                        aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties to allow customizing the build.

                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                          interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                              env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                                              stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                              tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                              notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                              synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                                              terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                              analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                              crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                              permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                                              suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                              propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                              ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                                                                                              ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                              projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                                                                                              vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                                                                                              buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                                                                                              environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                                                                                              encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                                                                                              sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                          • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                                                            • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                          description? +
                                                                                                                                                                                                                                                                                                                                                                                                                                          interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                              env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                                              stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                              tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                              notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                              synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                                              terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                              analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                              crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                              permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                                              suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                              propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                                                              pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                              ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                                                                                              ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                              projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                                                                                              vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                                                                                              buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                                                                                              environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                                                                                              encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                                                                                              sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                          • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                                                            • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                          description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline source bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                                                          ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                                                          Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                          projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                                                                                          The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                          vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                                                                                          VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                          buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                                                                                          Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                          environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                                                                                          Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                          encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                                                                          The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                          sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                          Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                          The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                                                          ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                                                          Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                                                                                          The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                                                                                          VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                                                                                          Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                                                                                          Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                                                                          The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                          Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index ff00172..f786b19 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                                          aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface PipelineResourcesProps

                                                                                                                                                                                                                                                                                                                                                                                                                                            Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                                                              • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                            description? +
                                                                                                                                                                                                                                                                                                                                                                                                                                            interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                                                stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                                                suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                            • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                                                              • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                            description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                            resource_prefix: string

                                                                                                                                                                                                                                                                                                                                                                                                                                            The resource prefix

                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                            The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                            The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                            The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                            The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                            Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                            The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                            The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                            The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                            The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                            Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                            From 825c47f96250a08c10754121fff0b7359b804ae4 Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Tue, 18 Nov 2025 09:42:24 +0000 Subject: [PATCH 75/75] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aw?= =?UTF-8?q?s4embeddedlinux/aws4embeddedlinux-ci@5da93243ebcafd143fb004d27f?= =?UTF-8?q?c5ed26acb5d318=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../EmbeddedLinuxCodeBuildProjectStack.html | 4 +-- ...beddedLinuxCodePipelineBaseImageStack.html | 8 ++--- classes/EmbeddedLinuxCodePipelineStack.html | 4 +-- classes/PipelineResourcesStack.html | 18 +++++------ enums/ProjectType.html | 18 +++++------ .../EmbeddedLinuxCodeBuildProjectProps.html | 12 ++++---- ...beddedLinuxCodePipelineBaseImageProps.html | 12 ++++---- .../EmbeddedLinuxCodePipelineProps.html | 30 +++++++++---------- interfaces/PipelineResourcesProps.html | 14 ++++----- 9 files changed, 60 insertions(+), 60 deletions(-) diff --git a/classes/EmbeddedLinuxCodeBuildProjectStack.html b/classes/EmbeddedLinuxCodeBuildProjectStack.html index bc4e67a..d43d256 100644 --- a/classes/EmbeddedLinuxCodeBuildProjectStack.html +++ b/classes/EmbeddedLinuxCodeBuildProjectStack.html @@ -1,6 +1,6 @@ EmbeddedLinuxCodeBuildProjectStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                                            aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                              Class EmbeddedLinuxCodeBuildProjectStack

                                                                                                                                                                                                                                                                                                                                                                                                                                              The stack for creating a build pipeline.

                                                                                                                                                                                                                                                                                                                                                                                                                                              See EmbeddedLinuxCodeBuildProjectProps for configration options.

                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                              • Stack
                                                                                                                                                                                                                                                                                                                                                                                                                                                • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                              constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                              • Stack
                                                                                                                                                                                                                                                                                                                                                                                                                                                • EmbeddedLinuxCodeBuildProjectStack
                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                              constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                              tags templateOptions region @@ -52,7 +52,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                              tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                                                              Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                              tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                                                              Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                                                              templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                              Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                                                                                                              region: string

                                                                                                                                                                                                                                                                                                                                                                                                                                              The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                                                                                                              This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html index 9fa2bd5..d5a79b9 100644 --- a/classes/EmbeddedLinuxCodePipelineBaseImageStack.html +++ b/classes/EmbeddedLinuxCodePipelineBaseImageStack.html @@ -1,7 +1,7 @@ EmbeddedLinuxCodePipelineBaseImageStack | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                                              aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                Class EmbeddedLinuxCodePipelineBaseImageStack

                                                                                                                                                                                                                                                                                                                                                                                                                                                The pipeline for building the CodeBuild Image used in other pipelines. This will produce an image for an OS based on verified Yocto hosts.

                                                                                                                                                                                                                                                                                                                                                                                                                                                For configuration options see BuildBaseImageCodePipelineProps.

                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                • Stack
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                • Stack
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • EmbeddedLinuxCodePipelineBaseImageStack
                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                tags templateOptions region @@ -55,7 +55,7 @@ removeStackTag isConstruct toString -

                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                tags: TagManager

                                                                                                                                                                                                                                                                                                                                                                                                                                                Tags to be applied to the stack.

                                                                                                                                                                                                                                                                                                                                                                                                                                                templateOptions: ITemplateOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                Options for CloudFormation template (like version, transform, description).

                                                                                                                                                                                                                                                                                                                                                                                                                                                region: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                The AWS region into which this stack will be deployed (e.g. us-west-2).

                                                                                                                                                                                                                                                                                                                                                                                                                                                This value is resolved according to the following rules:

                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -112,8 +112,8 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                Readonly Internal_crossRegionReferences

                                                                                                                                                                                                                                                                                                                                                                                                                                                _crossRegionReferences: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                Whether cross region references are enabled for this stack

                                                                                                                                                                                                                                                                                                                                                                                                                                                Optional Readonly Internal_notificationArns

                                                                                                                                                                                                                                                                                                                                                                                                                                                _notificationArns?: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                SNS Notification ARNs to receive stack events.

                                                                                                                                                                                                                                                                                                                                                                                                                                                ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                                                                The ECR Repository where the image is located.

                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                node: Node

                                                                                                                                                                                                                                                                                                                                                                                                                                                The tree node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                The ECR Image Tag to find the base imaged.

                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                node: Node

                                                                                                                                                                                                                                                                                                                                                                                                                                                The tree node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                                                • get terminationProtection(): boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether termination protection is enabled for this stack.

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                • set terminationProtection(value: boolean): void

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                  • value: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                • get dependencies(): Stack[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return the stacks this stack depends on

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Stack[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                                Artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                                                                The ECR Repository to push to.

                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                                                                                The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/interfaces/EmbeddedLinuxCodePipelineProps.html b/interfaces/EmbeddedLinuxCodePipelineProps.html index a6a290a..71474bb 100644 --- a/interfaces/EmbeddedLinuxCodePipelineProps.html +++ b/interfaces/EmbeddedLinuxCodePipelineProps.html @@ -1,5 +1,5 @@ EmbeddedLinuxCodePipelineProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                                                aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface EmbeddedLinuxCodePipelineProps

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties to allow customizing the build.

                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                      notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                      environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                                                                                                      encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                  • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                  description? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface EmbeddedLinuxCodePipelineProps {
                                                                                                                                                                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                      notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                      synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineSourceBucket: IBucket;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineSourcePrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineArtifactPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputBucket: Bucket;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      pipelineOutputPrefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ecrRepository: IRepository;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ecrRepositoryImageTag: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      projectType: ProjectType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      vpc: IVpc;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      buildPolicyAdditions?: PolicyStatement[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                      environmentVariables?: { [key: string]: BuildEnvironmentVariable };
                                                                                                                                                                                                                                                                                                                                                                                                                                                      encryptionKey: Key;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      sourceCustomPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                  • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • EmbeddedLinuxCodePipelineProps
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                  description? env? stackName? tags? @@ -115,17 +115,17 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineSourceBucket: IBucket

                                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline source bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                                                                  ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                                                                                                  The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                                                                                                  VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                                                                                  The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineSourcePrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline source prefix

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineArtifactPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline artifact bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputBucket: Bucket

                                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket to use

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  pipelineOutputPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                  The pipeline output bucket prefix to use

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  ecrRepository: IRepository

                                                                                                                                                                                                                                                                                                                                                                                                                                                  ECR Repository where the Build Host Image resides.

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  ecrRepositoryImageTag: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Tag for the Build Host Image

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  projectType: ProjectType

                                                                                                                                                                                                                                                                                                                                                                                                                                                  The type of project being built.

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  vpc: IVpc

                                                                                                                                                                                                                                                                                                                                                                                                                                                  VPC where the networking setup resides.

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  buildPolicyAdditions?: PolicyStatement[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Additional policy statements to add to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  environmentVariables?: { [key: string]: BuildEnvironmentVariable }

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Additional build environment variables to the build project.

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  encryptionKey: Key

                                                                                                                                                                                                                                                                                                                                                                                                                                                  The encryption key use across

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  sourceCustomPath?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Custom asset to be provided when using ProjectType.Custom

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/interfaces/PipelineResourcesProps.html b/interfaces/PipelineResourcesProps.html index f786b19..9714fab 100644 --- a/interfaces/PipelineResourcesProps.html +++ b/interfaces/PipelineResourcesProps.html @@ -1,5 +1,5 @@ PipelineResourcesProps | aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                                                  aws4embeddedlinux-cdk-lib
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface PipelineResourcesProps

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Select options for the PipelineResourcesStack.

                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                        resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                    description? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface PipelineResourcesProps {
                                                                                                                                                                                                                                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        env?: Environment;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        stackName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        tags?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                        notificationArns?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                        synthesizer?: IStackSynthesizer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        terminationProtection?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        analyticsReporting?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        crossRegionReferences?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        permissionsBoundary?: PermissionsBoundary;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        suppressTemplateIndentation?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        propertyInjectors?: IPropertyInjector[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                        resource_prefix: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        ecrRepositoryName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineArtifactBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineSourceBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        pipelineOutputBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        loggingBucketName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • StackProps
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • PipelineResourcesProps
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                    description? env? stackName? tags? @@ -107,9 +107,9 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                    resource_prefix: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                    The resource prefix

                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                    The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                    The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                    The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                    The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ecrRepositoryName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                    The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    pipelineArtifactBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                    The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    pipelineSourceBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                    The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    pipelineOutputBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                    The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    loggingBucketName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties